From bad9ab54332be2b8c2f446aac1a272f057f06aa0 Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Wed, 8 Jun 2022 10:03:13 +0530 Subject: [PATCH 1/3] Add ACS 4.17 support --- cloudstack/AccountService.go | 8 +- cloudstack/AffinityGroupService.go | 2 +- cloudstack/BrocadeVCSService.go | 6 + cloudstack/DiskOfferingService.go | 58 + cloudstack/EventService.go | 69 +- cloudstack/FirewallService.go | 6 + cloudstack/ISOService.go | 4 +- cloudstack/InternalLBService.go | 3 + cloudstack/NetworkACLService.go | 2 + cloudstack/NetworkOfferingService.go | 21 + cloudstack/NetworkService.go | 128 + cloudstack/NicService.go | 2 +- 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/UserService.go | 8 +- cloudstack/VLANService.go | 2 + cloudstack/VPCService.go | 156 +- cloudstack/VPCService_mock.go | 8 +- cloudstack/VirtualMachineService.go | 362 +- cloudstack/VolumeService.go | 11 + cloudstack/cloudstack.go | 2 +- generate/listApis.json | 114670 ++++++++++++------------ test/SSHService_test.go | 2 +- test/VPCService_test.go | 2 +- 28 files changed, 58741 insertions(+), 56888 deletions(-) diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 66270b62..8ad991fb 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -1005,7 +1005,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 { @@ -1054,18 +1054,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/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index 3d6ae187..dbce39ef 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 fc902744..20a064da 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 string `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 863a0460..a5f6c8cb 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{}) @@ -640,6 +659,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"` @@ -787,6 +807,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)) } @@ -913,6 +939,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{}) @@ -1055,6 +1111,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"` @@ -1521,6 +1578,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 e2dbd997..670bfb9b 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 165b4a96..5c1ba2b5 100644 --- a/cloudstack/FirewallService.go +++ b/cloudstack/FirewallService.go @@ -676,6 +676,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 +926,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 +1901,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 +2242,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 +2879,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 +3015,7 @@ type UpdateFirewallRuleResponse struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type UpdatePortForwardingRuleParams struct { diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index db285a38..7fea0af7 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/InternalLBService.go b/cloudstack/InternalLBService.go index 44922d0c..d65054df 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/NetworkACLService.go b/cloudstack/NetworkACLService.go index 41fe2dd5..475b1b6e 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 7ae5bffc..932b11dd 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 914c2a16..fbcf408d 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -399,6 +399,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 +535,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 +991,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 +1005,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 string `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 +1825,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 +2416,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 +2430,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 string `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 +2817,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 +2853,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 +2902,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 +2944,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 +3094,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 +3289,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 +3450,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 +3464,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 string `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 +3693,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 +3707,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 string `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 +4055,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 +4069,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 string `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 +4847,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 +4888,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 +5246,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 +5260,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 string `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/NicService.go b/cloudstack/NicService.go index 08463e51..58c50c30 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -554,7 +554,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 7766d8d8..723de17f 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 8c4f81a9..0a7bad71 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 aef62e10..d1c8b1c4 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 0ea3ed6c..fa39fa5d 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 402ef154..5dc3aa66 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 f469d12e..b5523bb6 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/UserService.go b/cloudstack/UserService.go index 3c024cf6..7f86f377 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 6bba3024..79a1be21 100644 --- a/cloudstack/VLANService.go +++ b/cloudstack/VLANService.go @@ -407,6 +407,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 +1248,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"` diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index f7c9f80e..7331b725 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 string `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 string `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 string `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 ae219c7b..33dde553 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 88b55fd7..bf0cd920 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -271,7 +271,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 +566,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 +684,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 +697,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 +760,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 +805,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 +885,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 +1164,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 +1186,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 +1670,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 +1759,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 +2040,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 +2301,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 +2558,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 +2596,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 +2640,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 +2659,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 +2696,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 +2726,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 +3372,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 +3493,16 @@ 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["details"]; found { vv := strings.Join(v.([]string), ",") u.Set("details", vv) @@ -3377,9 +3525,6 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("haenable", vv) } - if v, found := p.p["hostid"]; found { - u.Set("hostid", v.(string)) - } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -3421,9 +3566,6 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } - if v, found := p.p["podid"]; found { - u.Set("podid", v.(string)) - } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } @@ -3440,9 +3582,6 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["state"]; found { u.Set("state", 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) { @@ -3480,6 +3619,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 +3649,21 @@ 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) SetDetails(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3585,21 +3754,6 @@ func (p *ListVirtualMachinesMetricsParams) GetHaenable() (bool, bool) { return value, ok } -func (p *ListVirtualMachinesMetricsParams) SetHostid(v string) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - p.p["hostid"] = v -} - -func (p *ListVirtualMachinesMetricsParams) GetHostid() (string, bool) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - value, ok := p.p["hostid"].(string) - return value, ok -} - func (p *ListVirtualMachinesMetricsParams) SetHypervisor(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3780,21 +3934,6 @@ func (p *ListVirtualMachinesMetricsParams) GetPagesize() (int, bool) { return value, ok } -func (p *ListVirtualMachinesMetricsParams) SetPodid(v string) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - p.p["podid"] = v -} - -func (p *ListVirtualMachinesMetricsParams) GetPodid() (string, bool) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - value, ok := p.p["podid"].(string) - return value, ok -} - func (p *ListVirtualMachinesMetricsParams) SetProjectid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3870,21 +4009,6 @@ func (p *ListVirtualMachinesMetricsParams) GetState() (string, bool) { return value, ok } -func (p *ListVirtualMachinesMetricsParams) SetStorageid(v string) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - p.p["storageid"] = v -} - -func (p *ListVirtualMachinesMetricsParams) GetStorageid() (string, bool) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - value, ok := p.p["storageid"].(string) - return value, ok -} - func (p *ListVirtualMachinesMetricsParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4116,7 +4240,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 +4521,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 +4799,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 +5060,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 +5263,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 +5505,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 +5728,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 +5969,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 +6087,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 +6100,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 +6163,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 +6208,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 +6475,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 +6717,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 +6959,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 +7478,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"` diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index 081086b4..d2348ae6 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -205,6 +205,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 +568,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 +819,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 +999,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 +2140,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 +2740,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 +2941,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 +3065,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 +3303,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 +3573,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 +3882,7 @@ 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"` diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index 0ca6a126..fcd6db7e 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -39,7 +39,7 @@ import ( "strings" "time" - "github.com/golang/mock/gomock" + gomock "github.com/golang/mock/gomock" ) // UnlimitedResourceID is a special ID to define an unlimited resource diff --git a/generate/listApis.json b/generate/listApis.json index d8b16b66..e3438b92 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -22,21 +22,14 @@ ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44,9 +37,16 @@ "name": "resourcetype", "type": "resourceobjecttype" }, + {}, { - "description": "id of the resource", - "name": "resourceid", + "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" } ], @@ -57,6 +57,13 @@ "isasync": true, "name": "createVPCOffering", "params": [ + { + "description": "the display text of the vpc offering", + "length": 255, + "name": "displaytext", + "required": true, + "type": "string" + }, { "description": "the ID of the containing zone(s), null for public offerings", "length": 255, @@ -67,12 +74,28 @@ "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "servicecapabilitylist", "required": false, - "type": "list" + "since": "4.4", + "type": "map" + }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" }, { "description": "the ID of the service offering for the VPC router appliance", @@ -83,11 +106,11 @@ "type": "uuid" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "the name of the vpc offering", "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { "description": "services supported by the vpc offering", @@ -97,79 +120,27 @@ "type": "list" }, { - "description": "desired service capabilities as part of vpc offering", + "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": "servicecapabilitylist", + "name": "serviceproviderlist", "required": false, - "since": "4.4", "type": "map" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "enable", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the display text of the vpc offering", - "length": 255, - "name": "displaytext", - "required": true, - "type": "string" + "type": "list" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" - }, - {}, - {}, - { - "description": "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": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { "description": "the list of supported services", @@ -194,21 +165,11 @@ "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", @@ -218,6 +179,16 @@ "description": "the provider name", "name": "name", "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "type": "list" @@ -231,15 +202,15 @@ "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" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -248,34 +219,76 @@ "type": "list" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" }, { "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", "name": "distributedvpcrouter", "type": "boolean" }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "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 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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "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", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -292,56 +305,96 @@ "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the netmask for the Pod", "length": 255, - "name": "endip", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "startip", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the netmask for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "netmask", + "name": "name", "required": true, "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", + "description": "the ending IP address for the Pod", "length": 255, - "name": "allocationstate", + "name": "endip", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "name", + "name": "startip", "required": true, "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "allocationstate", + "required": false, + "type": "string" } ], "related": "listPods,updatePod,createManagementNetworkIpRange", "response": [ + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, {}, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, { "description": "the ending IP for the range", "name": "endip", @@ -353,13 +406,13 @@ "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], @@ -371,58 +424,38 @@ "type": "list" }, { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "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 percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity name", @@ -435,14 +468,19 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the Pod name", @@ -450,59 +488,44 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster name", + "name": "clustername", "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 allocation state of the Pod", - "name": "allocationstate", + "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 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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the name of the Pod", + "name": "name", "type": "string" }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, { "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", "name": "forsystemvms", "type": "list" - }, - {} + } ] }, { @@ -511,54 +534,48 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the account under the specified role.", "length": 255, - "name": "timezone", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Network domain for the account's networks", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "accountid", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "details for account used to store specific parameters", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "accountdetails", + "name": "userid", "required": false, - "type": "map" + "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Network domain for the account's networks", "length": 255, - "name": "userid", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "details for account used to store specific parameters", "length": 255, - "name": "accounttype", + "name": "accountdetails", "required": false, - "type": "short" + "type": "map" }, { "description": "Unique username.", @@ -575,94 +592,80 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, + "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, { "description": "the total number of 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", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "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 projects available for administration by this account", - "name": "projectavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total volume available for this account", + "name": "volumeavailable", "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", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { @@ -671,80 +674,73 @@ "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "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 list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -753,63 +749,33 @@ "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", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "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 list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "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", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "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" }, { @@ -818,52 +784,47 @@ "type": "map" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of 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 snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -872,28 +833,18 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "description": "the user ID", - "name": "id", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -902,61 +853,71 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "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 account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" } ], "type": "list" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -965,44 +926,106 @@ "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { "description": "the total number of templates available to be created by this account", "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + {}, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" } ], "since": "4.2.0" @@ -1022,27 +1045,27 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.6.0" }, @@ -1052,21 +1075,13 @@ "name": "copyIso", "params": [ { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, { "description": "Template ID.", "length": 255, @@ -1076,90 +1091,130 @@ "type": "uuid" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "sourcezoneid", + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "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 the template is managed across all Zones, false otherwise", @@ -1167,135 +1222,105 @@ "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 ID of the OS type for this template.", + "name": "ostypeid", "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": "checksum of the template", - "name": "checksum", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "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": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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": "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": "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" }, { @@ -1304,45 +1329,44 @@ "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, - {}, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "true if template requires HVM enabled, false otherwise", @@ -1350,13 +1374,18 @@ "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -1370,62 +1399,41 @@ "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - {}, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } ] }, { - "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "description": "Deletes a autoscale vm profile.", "isasync": true, - "name": "provisionCertificate", + "name": "deleteAutoScaleVmProfile", "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, - "name": "reconnect", - "required": false, - "type": "boolean" - }, - { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "description": "the ID of the autoscale profile", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "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" }, {}, { @@ -1434,39 +1442,53 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Deletes a autoscale vm profile.", + "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", "isasync": true, - "name": "deleteAutoScaleVmProfile", + "name": "provisionCertificate", "params": [ { - "description": "the ID of the autoscale profile", + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": true, "type": "uuid" + }, + { + "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "length": 255, + "name": "reconnect", + "required": false, + "type": "boolean" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -1478,26 +1500,19 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} - ] + ], + "since": "4.11.0" }, { "description": "Adds an external firewall appliance", "isasync": false, "name": "addExternalFirewall", "params": [ - { - "description": "Zone in which to add the external firewall appliance.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "Username of the external firewall appliance.", "length": 255, @@ -1512,6 +1527,14 @@ "required": true, "type": "string" }, + { + "description": "Zone in which to add the external firewall appliance.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "URL of the external firewall appliance.", "length": 255, @@ -1523,13 +1546,13 @@ "related": "listExternalFirewalls", "response": [ { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { @@ -1537,25 +1560,21 @@ "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", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -1563,13 +1582,13 @@ "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { @@ -1578,133 +1597,126 @@ "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { "description": "the ID of the network device", "name": "id", "type": "string" + }, + { + "description": "the username that's used to log in to the external firewall", + "name": "username", + "type": "string" } ] }, { - "description": "Deletes a F5 external load balancer appliance added in a zone.", + "description": "Lists VM metrics", "isasync": false, - "name": "deleteExternalLoadBalancer", + "name": "listVirtualMachinesMetrics", "params": [ { - "description": "Id of the external loadbalancer appliance.", + "description": "list resources by account. Must be used with the domainId parameter.", "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", + "name": "account", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, - {} - ] - }, - { - "description": "Lists VM metrics", - "isasync": false, - "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 vms by affinity group", "length": 255, - "name": "details", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "list vms by ssh keypair name", "length": 255, - "name": "hypervisor", + "name": "keypair", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "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 security group ID", "length": 255, - "name": "isoid", + "name": "securitygroupid", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, + "since": "4.15", "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" }, { - "description": "the ID of the virtual machine", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "showicon", "required": false, - "type": "uuid" + "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.", + "description": "list by the backup offering", "length": 255, - "name": "isrecursive", + "name": "backupofferingid", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "the host ID", + "description": "list vms by vpc", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -1716,58 +1728,50 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "displayvm", + "name": "haenable", "required": false, - "since": "4.4", + "since": "4.15", "type": "boolean" }, { - "description": "the security group ID", + "description": "the availability zone ID", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "forvirtualnetwork", + "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, - "type": "boolean" + "since": "4.4", + "type": "list" }, { - "description": "List by keyword", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", - "required": false, - "type": "uuid" - }, - { - "description": "list by network id", + "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": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "details", "required": false, - "type": "uuid" + "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 target hypervisor for the template", "length": 255, - "name": "listall", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -1777,58 +1781,48 @@ "type": "integer" }, { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "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 iso", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "tags", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "map" + "type": "uuid" }, { - "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "haenable", + "name": "displayvm", "required": false, - "since": "4.15", + "since": "4.4", "type": "boolean" }, { - "description": "list vms by vpc", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "the group ID", @@ -1838,31 +1832,6 @@ "required": false, "type": "uuid" }, - { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "since": "4.4", - "type": "list" - }, - { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.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.", "length": 255, @@ -1871,118 +1840,288 @@ "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": "list by the service offering", + "description": "the ID of the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keypair", + "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" } ], "related": "", "response": [ + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "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 project name of the vm", + "name": "project", + "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": "publicip", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "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 ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { "description": "Id of the vm to which the nic belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -1991,13 +2130,18 @@ "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the 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" }, { @@ -2006,9 +2150,14 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "the IPv6 address of network", @@ -2016,424 +2165,103 @@ "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": "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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" } ], "type": "set" }, { - "description": "network write in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "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", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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", - "type": "string" - }, - { - "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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 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 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": "network read in MiB", - "name": "networkread", + "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": "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 speed of each cpu", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - {}, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "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 ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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 number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "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 project id of the vm", - "name": "projectid", - "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", @@ -2444,91 +2272,54 @@ "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", + "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "security group name", "name": "securitygroupname", @@ -2544,128 +2335,140 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" - }, + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "account owning the security group rule", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -2674,19 +2477,9 @@ "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 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", @@ -2694,37 +2487,27 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -2737,16 +2520,31 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -2754,67 +2552,97 @@ } ], "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, - {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, + {}, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { @@ -2823,8 +2651,33 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the 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": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { @@ -2833,29 +2686,91 @@ "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { "description": "disk write in MiB", @@ -2863,29 +2778,90 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "network read in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + {}, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" } ], "since": "4.9.3" @@ -2896,33 +2872,26 @@ "name": "listHosts", "params": [ { - "description": "List by keyword", + "description": "the state of the host", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "description": "the id of the host", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", - "length": 255, - "name": "outofbandmanagementpowerstate", - "required": false, - "type": "string" - }, - { - "description": "the state of the host", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -2932,34 +2901,25 @@ "type": "integer" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "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": "hypervisor", + "name": "resourcestate", "required": false, "type": "string" }, { - "description": "the host type", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "length": 255, - "name": "type", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "the id of the host", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", - "required": false, - "type": "uuid" - }, - { - "description": "the Zone ID for the host", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "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]", @@ -2969,11 +2929,11 @@ "type": "list" }, { - "description": "", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { "description": "if true, list only hosts dedicated to HA", @@ -2983,25 +2943,33 @@ "type": "boolean" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "the Pod ID for the host", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "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": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "resourcestate", + "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": "the host type", + "length": 255, + "name": "type", "required": false, "type": "string" }, @@ -3018,126 +2986,44 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "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", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "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 Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -3145,14 +3031,19 @@ "name": "vgputype", "type": "string" }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -3172,75 +3063,70 @@ } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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 Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, + {}, { "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the 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", - "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 number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { "description": "the amount of the host's CPU currently allocated in MHz", @@ -3253,39 +3139,59 @@ "type": "string" }, { - "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 currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "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 CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "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 cluster name of the host", + "name": "clustername", + "type": "string" }, { "description": "the host HA information information", @@ -3293,95 +3199,165 @@ "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the ID of the host", - "name": "id", + "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", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "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", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, { "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" } ] }, @@ -3401,28 +3377,28 @@ "description": "Storage pool id", "length": 255, "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -3450,6 +3426,14 @@ "required": false, "type": "integer" }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "ID of the storage policy", "length": 255, @@ -3464,134 +3448,116 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the storage pool path", - "name": "path", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, + {}, { "description": "the storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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 IP address of the storage pool", - "name": "ipaddress", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the 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": "IOPS CloudStack can provision from this storage pool", "name": "capacityiops", "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 Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, { "description": "the scope of the storage pool", "name": "scope", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "the date and time the storage pool was created", @@ -3599,52 +3565,94 @@ "type": "date" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "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": "Updates a storage pool.", - "isasync": false, - "name": "updateStoragePool", + "description": "Deletes an existing guest network IPv6 prefix.", + "isasync": true, + "name": "deleteGuestNetworkIpv6Prefix", "params": [ { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Id of the guest network IPv6 prefix", "length": 255, - "name": "enabled", - "required": false, + "name": "id", + "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "Change the name of the storage pool", + "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.", + "isasync": false, + "name": "updateStoragePool", + "params": [ + { + "description": "the Id of the storage pool", "length": 255, - "name": "name", + "name": "id", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.15", - "type": "string" + "required": true, + "type": "uuid" }, { - "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" }, @@ -3656,17 +3664,25 @@ "type": "list" }, { - "description": "the Id of the storage pool", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "id", + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "Change the name of the storage pool", + "length": 255, + "name": "name", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "required": false, + "since": "4.15", + "type": "string" }, { - "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" } @@ -3674,70 +3690,54 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the name of the storage pool", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "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": "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 Zone name of the storage pool", - "name": "zonename", + "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { "description": "the storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -3746,9 +3746,14 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "the host's currently allocated disk size", @@ -3756,33 +3761,49 @@ "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -3791,14 +3812,14 @@ "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { "description": "the ID of the cluster for the storage pool", @@ -3806,14 +3827,9 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" } ], "since": "3.0.0" @@ -3843,19 +3859,18 @@ "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, - {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -3864,23 +3879,19 @@ "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 systemvm agent version", + "name": "version", + "type": "string" }, + {}, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { @@ -3889,13 +3900,18 @@ "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -3904,109 +3920,114 @@ "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "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 state of the system VM", - "name": "state", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { "description": "the private MAC address for the system VM", "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -4015,29 +4036,24 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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" } ] }, @@ -4046,13 +4062,6 @@ "isasync": false, "name": "importLdapUsers", "params": [ - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" - }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, @@ -4061,34 +4070,33 @@ "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": "Creates the account under the specified role.", + "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": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "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": "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "group", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -4098,53 +4106,55 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "keyword", + "name": "timezone", "required": false, "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": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "group", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "details for account used to store specific parameters", + "description": "Creates the account under the specified role.", "length": 255, - "name": "accountdetails", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "map" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "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 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's email", + "name": "email", "type": "string" }, { @@ -4153,19 +4163,25 @@ "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's principle", + "name": "principal", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's domain", + "name": "domain", "type": "string" } ], @@ -4177,10 +4193,10 @@ "name": "listDedicatedZones", "params": [ { - "description": "the ID of the domain associated with the zone", + "description": "the ID of the Zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -4199,10 +4215,17 @@ "type": "string" }, { - "description": "the ID of the Zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", + "required": false, + "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" }, @@ -4220,20 +4243,18 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "dedicateZone", "response": [ { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4241,37 +4262,32 @@ "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "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" } ] }, @@ -4281,17 +4297,9 @@ "name": "listNetworks", "params": [ { - "description": "the zone ID of the network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "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" }, @@ -4303,86 +4311,89 @@ "type": "list" }, { - "description": "", + "description": "list networks available for VM deployment", "length": 255, - "name": "pagesize", + "name": "canusefordeploy", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list networks by physical network id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "true if network is system, false otherwise", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "issystem", + "name": "acltype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "List networks by VPC", "length": 255, - "name": "acltype", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "type of the traffic", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID or VID of the network", "length": 255, - "name": "displaynetwork", + "name": "vlan", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "isrecursive", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "uuid" }, { - "description": "list networks by restartRequired", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "restartrequired", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list networks by network offering ID", "length": 255, - "name": "account", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "type", + "name": "specifyipranges", "required": false, - "type": "string" + "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,createProject,listProjects,suspendProject,updateProject", @@ -4390,221 +4401,326 @@ "type": "uuid" }, { - "description": "the network belongs to VPC", + "description": "true if network is system, false otherwise", "length": 255, - "name": "forvpc", + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List resources by 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": "If set to false, list only 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 networks by ID", "length": 255, - "name": "listall", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the network belongs to VPC", + "length": 255, + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "type of the traffic", + "description": "", "length": 255, - "name": "traffictype", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "length": 255, + "name": "type", "required": false, "type": "string" }, { - "description": "list networks by network offering ID", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "displaynetwork", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list networks by ID", + "description": "", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "List networks by VPC", + "description": "list networks by physical network id", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "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": "specifyipranges", + "name": "networkfilter", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" + }, + { + "description": "the zone ID of the network", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], - "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the displaytext of the network", + "name": "displaytext", "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, - {}, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The external id of the network", + "name": "externalid", "type": "string" }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, { "description": "name of the network offering the network is created from", "name": "networkofferingname", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the id of the network", - "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 network domain", - "name": "networkdomain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -4612,38 +4728,38 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -4652,138 +4768,77 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + {}, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the first DNS for the network", + "name": "dns1", "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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { @@ -4792,104 +4847,130 @@ "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, + {}, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, { "description": "list networks that are persistent", "name": "ispersistent", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "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": "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" } ] }, @@ -4913,25 +4994,26 @@ "name": "id", "type": "string" }, - {}, - { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, { "description": "controller of the pool", "name": "controllerid", "type": "string" }, + {}, + {}, { "description": "the name of the storage pool", "name": "name", "type": "string" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "the state of the storage pool", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4939,11 +5021,38 @@ "name": "size", "type": "long" }, + { + "description": "available iops of the pool", + "name": "maxiops", + "type": "long" + }, + { + "description": "default gateway of the pool", + "name": "gateway", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "Releases an IP address from the account.", + "isasync": false, + "name": "releaseIpAddress", + "params": [ + { + "description": "the ID of the public IP address to release", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -4951,11 +5060,23 @@ }, {}, { - "description": "the state of the storage pool", - "name": "state", + "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.17" }, { "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", @@ -4963,20 +5084,20 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "The current starting IP address.", + "description": "The current ending IP address.", "length": 255, - "name": "currentstartip", + "name": "currentendip", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "string" }, { - "description": "The current ending IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "currentendip", + "name": "podid", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { "description": "The new ending IP address.", @@ -4986,12 +5107,12 @@ "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The current starting IP address.", "length": 255, - "name": "podid", + "name": "currentstartip", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The new starting IP address.", @@ -5002,16 +5123,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", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -5019,11 +5141,10 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.16.0.0" }, @@ -5040,14 +5161,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "the ID of the firewall rule", - "length": 255, - "name": "id", - "related": "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, @@ -5055,18 +5168,21 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { @@ -5074,25 +5190,25 @@ "name": "endport", "type": "integer" }, - {}, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { @@ -5100,13 +5216,8 @@ "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -5114,19 +5225,14 @@ "name": "domain", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -5134,27 +5240,37 @@ "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": "tag value", "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -5163,19 +5279,24 @@ "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", + "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -5184,14 +5305,19 @@ "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "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" } ], "since": "4.4" @@ -5203,6 +5329,7 @@ "params": [], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -5214,7 +5341,6 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "is quota service enabled", "name": "isenabled", @@ -5229,26 +5355,20 @@ "name": "listSrxFirewalls", "params": [ { - "description": "", + "description": "SRX firewall device ID", "length": 255, - "name": "page", + "name": "fwdeviceid", + "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -5258,95 +5378,102 @@ "type": "uuid" }, { - "description": "SRX firewall device ID", + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addSrxFirewall,configureSrxFirewall", "response": [ { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, + {}, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { @@ -5355,11 +5482,10 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -5389,7 +5515,11 @@ "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "any text associated with the success or failure", @@ -5401,11 +5531,7 @@ "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" }, @@ -5426,16 +5552,16 @@ "related": "", "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "Hypervisor name", @@ -5475,137 +5601,293 @@ "related": "listOsTypes,addGuestOs", "response": [ { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the name/description of the OS type", + "name": "description", + "type": "string" }, - {}, { "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the OS type", "name": "id", "type": "string" }, - { - "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.4.0" }, { - "description": "Updates resource limits for an account or domain.", + "description": "Lists all guest vlans", "isasync": false, - "name": "updateResourceLimit", + "name": "listGuestVlans", "params": [ { - "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" + }, + { + "description": "list guest vlan by vnet", + "length": 255, + "name": "vnet", "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. ", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, + "name": "page", + "required": false, "type": "integer" }, { - "description": " Maximum resource limit.", + "description": "list guest vlan by id", "length": 255, - "name": "max", + "name": "id", "required": false, "type": "long" }, { - "description": "Update resource limits for project", + "description": "list guest vlan by zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "list guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } ], - "related": "listResourceLimits", + "related": "", "response": [ { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the guest VLAN", + "name": "vlan", + "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the account of the guest VLAN range", + "name": "account", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" + }, + { + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "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" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates resource limits for an account or domain.", + "isasync": false, + "name": "updateResourceLimit", + "params": [ + { + "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "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, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } + ], + "related": "listResourceLimits", + "response": [ + { + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" + }, + { + "description": "the project id of the resource limit", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the resource limit", + "name": "project", + "type": "string" + }, + { + "description": "the account of the resource limit", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {} ] }, { @@ -5629,12 +5911,6 @@ "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", @@ -5644,6 +5920,12 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -5653,9 +5935,17 @@ "name": "listHostsMetrics", "params": [ { - "description": "the state of the host", + "description": "the id of the host", "length": 255, - "name": "state", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -5667,34 +5957,32 @@ "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the host type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the id of the host", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the Pod ID for the host", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "hahost", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the Zone ID for the host", @@ -5705,149 +5993,169 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "the name of the host", + "description": "the host type", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "hahost", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the name of the host", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "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": "page", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "lists hosts existing in particular cluster", "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": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "details", + "name": "outofbandmanagementenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "lists hosts existing in particular cluster", + "description": "the Pod ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "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": "the state of the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "state", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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 management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "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": "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 hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "the CPU number of the host", @@ -5855,24 +6163,20 @@ "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { "description": "events available for the host", @@ -5880,44 +6184,74 @@ "type": "string" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "network read in GiB", + "name": "networkread", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, { "description": "cpu usage notification threshold exceeded", "name": "cputhreshold", "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "the OS category name of the host", @@ -5925,20 +6259,40 @@ "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the total memory used in GiB", + "name": "memoryusedgb", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the 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": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -5952,24 +6306,14 @@ "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", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -5983,14 +6327,24 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", "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" } ], "type": "list" @@ -5999,119 +6353,84 @@ "type": "list" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "capabilities of the host", + "name": "capabilities", "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the date and time the host was last pinged", @@ -6119,120 +6438,83 @@ "type": "date" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "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": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, - {}, - {}, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "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 incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "network read in GiB", - "name": "networkread", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" } ], @@ -6258,22 +6540,22 @@ "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -6283,40 +6565,40 @@ "name": "listAffinityGroups", "params": [ { - "description": "lists affinity groups by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "isrecursive", + "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": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list objects by project", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list the affinity group by the ID provided", @@ -6327,17 +6609,25 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "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": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -6349,53 +6639,42 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "lists affinity groups by name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createAffinityGroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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 name of the affinity group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -6404,37 +6683,40 @@ "type": "list" }, { - "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 type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the affinity group", + "name": "description", "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 name of the affinity group", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -6443,10 +6725,10 @@ "name": "registerSSHKeyPair", "params": [ { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { @@ -6466,63 +6748,63 @@ "type": "uuid" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", "required": true, "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "Name of the keypair", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "related": "listSSHKeyPairs", "response": [ { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the owner of the keypair", "name": "account", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Name of the keypair", + "name": "name", "type": "string" }, {}, { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 domain id of the keypair owner", @@ -6540,34 +6822,34 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -6576,136 +6858,136 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the clusters to start maintenance on", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "podids", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "list" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "forced", + "name": "payload", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "timeout", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "payload", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "list" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "hostids", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "description": "the IDs of the hosts to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the hosts updated", - "name": "hostsupdated", + "description": "the hosts skipped", + "name": "hostsskipped", "response": [ { - "description": "output of the maintenance script on the host", - "name": "output", - "type": "string" - }, - { - "description": "end date of the update on the host", - "name": "enddate", + "description": "the ID of the skipped host", + "name": "hostid", "type": "string" }, { - "description": "the name of the updated host", + "description": "the name of the skipped host", "name": "hostname", "type": "string" }, { - "description": "the ID of the updated host", - "name": "hostid", - "type": "string" - }, - { - "description": "start date of the update on the host", - "name": "startdate", + "description": "the reason to skip the host", + "name": "reason", "type": "string" } ], "type": "list" }, + {}, + {}, { - "description": "the hosts skipped", - "name": "hostsskipped", + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" + }, + { + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, + { + "description": "the hosts updated", + "name": "hostsupdated", "response": [ { - "description": "the ID of the skipped host", + "description": "the ID of the updated host", "name": "hostid", "type": "string" }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "output of the maintenance script on the host", + "name": "output", "type": "string" }, { - "description": "the name of the skipped host", + "description": "start date of the update on the host", + "name": "startdate", + "type": "string" + }, + { + "description": "end date of the update on the host", + "name": "enddate", + "type": "string" + }, + { + "description": "the name of the updated host", "name": "hostname", "type": "string" } ], "type": "list" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -6714,14 +6996,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, @@ -6751,141 +7025,121 @@ "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the list to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "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 ID of the project 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": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "the account 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, - "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", - "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", + "name": "account", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "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": "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 group name of the virtual machine", - "name": "group", - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -6894,272 +7148,603 @@ "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the virtual network for the service offering", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the virtual network for the IP address", "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 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 Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "public IP address id", + "name": "id", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, {}, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "since": "4.17" + }, + { + "description": "Restore a VM to original template/ISO or new template/ISO", + "isasync": true, + "name": "restoreVirtualMachine", + "params": [ + { + "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + }, + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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" + } + ], + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", "name": "memoryintfreekbs", "type": "long" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "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 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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the security group", + "description": "the description of the affinity group", + "name": "description", + "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 security group", - "name": "description", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the 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": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the group", + "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 name of the affinity 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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 availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the 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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the 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" }, { @@ -7172,38 +7757,58 @@ "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, - { - "description": "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -7211,8 +7816,18 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -7223,45 +7838,20 @@ ], "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -7273,8 +7863,13 @@ "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": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -7282,43 +7877,43 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "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": "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" }, { @@ -7327,13 +7922,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -7345,136 +7950,156 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" - }, - { - "description": "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "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 state of the virtual machine", + "name": "state", + "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" + }, + { + "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 ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -7482,48 +8107,83 @@ "name": "boottype", "type": "string" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -7531,228 +8191,128 @@ "name": "networkid", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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" } ], "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", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the 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", + "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", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "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": "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", - "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" @@ -7763,9 +8323,9 @@ "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\")", + "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -7777,28 +8337,34 @@ "type": "string" }, { - "description": "the IDs of the events", + "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": "ids", - "related": "listEvents", + "name": "startdate", "required": false, - "type": "list" + "type": "date" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the events", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listEvents", "required": false, - "type": "date" + "type": "list" } ], "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", @@ -7808,12 +8374,6 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -7833,26 +8393,64 @@ ], "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": "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -7861,13 +8459,6 @@ "isasync": false, "name": "listUcsBlades", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -7882,6 +8473,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "ucs manager id", "length": 255, @@ -7894,13 +8492,8 @@ "related": "associateUcsProfileToBlade", "response": [ { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, - { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { @@ -7910,13 +8503,13 @@ }, {}, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "associated ucs profile dn", + "name": "profiledn", "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" }, { @@ -7924,50 +8517,17 @@ "name": "id", "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", "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 blade dn", + "name": "bladedn", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ] }, { @@ -7985,6 +8545,12 @@ ], "related": "getVolumeiScsiName", "response": [ + {}, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -7995,12 +8561,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "type": "string" - }, - {}, {} ] }, @@ -8027,28 +8587,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -8060,29 +8620,29 @@ "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": "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", @@ -8109,13 +8669,6 @@ "required": false, "type": "list" }, - { - "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, { "description": "the id of Os category to update the host with", "length": 255, @@ -8136,7 +8689,7 @@ "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" }, @@ -8147,19 +8700,46 @@ "required": false, "since": "4.11", "type": "string" + }, + { + "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" } ], - "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 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 Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { "description": "the CPU number of the host", @@ -8167,109 +8747,115 @@ "type": "integer" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + {}, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "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 Zone ID of the host", - "name": "zoneid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { "description": "GPU cards present in the host", @@ -8284,21 +8870,31 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", "type": "long" }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, { "description": "Video RAM for this vGPU type", "name": "videoram", @@ -8313,16 +8909,6 @@ "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" } ], "type": "list" @@ -8331,83 +8917,78 @@ "type": "list" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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 date and time the host was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "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 host version", - "name": "version", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "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": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -8416,101 +8997,80 @@ "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, {}, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - {}, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "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 last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" } ] }, @@ -8527,32 +9087,26 @@ "type": "integer" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "protocol", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" - }, - { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "error code for this icmp message", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "type of firewallrule: system/user", "length": 255, - "name": "destcidrlist", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { "description": "type of the icmp message being sent", @@ -8561,13 +9115,6 @@ "required": false, "type": "integer" }, - { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -8577,28 +9124,81 @@ "type": "boolean" }, { - "description": "type of firewallrule: system/user", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "type", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the network id of the port forwarding rule", + "description": "error code for this icmp message", "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", - "response": [ + "name": "icmpcode", + "required": false, + "type": "integer" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" + } + ], + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", + "response": [ + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, {}, { "description": "the starting port of firewall rule's port range", @@ -8606,8 +9206,8 @@ "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -8615,43 +9215,38 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -8660,72 +9255,42 @@ "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 value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "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", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "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 traffic type for the firewall rule", + "name": "traffictype", "type": "string" } ] @@ -8735,22 +9300,6 @@ "isasync": false, "name": "listVPCOfferings", "params": [ - { - "description": "list VPC offerings by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -8758,14 +9307,6 @@ "required": false, "type": "string" }, - { - "description": "list VPC offerings by id", - "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -8781,11 +9322,11 @@ "type": "string" }, { - "description": "", + "description": "list VPC offerings by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "true if need to list only default VPC offerings. Default value is false", @@ -8794,6 +9335,14 @@ "required": false, "type": "boolean" }, + { + "description": "list VPC offerings by id", + "length": 255, + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", + "required": false, + "type": "uuid" + }, { "description": "list VPC offerings supporting certain services", "length": 255, @@ -8807,68 +9356,80 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + {}, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the provider name", @@ -8876,28 +9437,28 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "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": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -8907,16 +9468,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", @@ -8924,40 +9485,49 @@ } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, - {}, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -8978,20 +9548,20 @@ "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,18 +9571,25 @@ "name": "uploadVolume", "params": [ { - "description": "Upload volume for the project", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "format", + "required": true, + "type": "string" }, { - "description": "the name of the volume", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, + "type": "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": "checksum", + "required": false, "type": "string" }, { @@ -9023,17 +9600,18 @@ "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://", - "length": 2048, - "name": "url", - "required": true, + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { @@ -9045,117 +9623,104 @@ "type": "uuid" }, { - "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": "the name of the volume", "length": 255, - "name": "format", + "name": "name", "required": true, "type": "string" }, { - "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", "required": true, - "type": "uuid" + "type": "string" } ], - "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 name of the template for the virtual machine", - "name": "templatename", - "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": "max iops of the disk volume", + "name": "maxiops", "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": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { "description": "ID of the availability zone", @@ -9163,62 +9728,87 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "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": "cluster id of the volume", - "name": "clusterid", + "description": "the project id of the vpn", + "name": "projectid", "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 project id of the vpn", - "name": "projectid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -9227,13 +9817,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -9242,13 +9832,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -9257,36 +9842,36 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -9295,170 +9880,160 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "cluster id of the volume", + "name": "clusterid", "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 read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "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": "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" } ] @@ -9468,13 +10043,6 @@ "isasync": false, "name": "listSecurityGroups", "params": [ - { - "description": "lists security groups by name", - "length": 255, - "name": "securitygroupname", - "required": false, - "type": "string" - }, { "description": "lists security groups by virtual machine id", "length": 255, @@ -9484,17 +10052,16 @@ "type": "uuid" }, { - "description": "list the security group by the id provided", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -9506,18 +10073,17 @@ "type": "map" }, { - "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 objects by project", + "description": "list the security group by the id provided", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, @@ -9529,102 +10095,164 @@ "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 by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "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": "", + "description": "lists security groups by name", "length": 255, - "name": "pagesize", + "name": "securitygroupname", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { - "description": "the 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": "tag value", + "name": "value", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the 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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -9633,268 +10261,215 @@ "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": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "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", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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 project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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" } ], "type": "set" }, - {}, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, {} ] }, @@ -9903,13 +10478,6 @@ "isasync": false, "name": "configureOutOfBandManagement", "params": [ - { - "description": "the host management interface IP address", - "length": 255, - "name": "address", - "required": true, - "type": "string" - }, { "description": "the host management interface port", "length": 255, @@ -9938,11 +10506,18 @@ "required": true, "type": "string" }, + { + "description": "the host management interface IP address", + "length": 255, + "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", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } @@ -9950,71 +10525,71 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the 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 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 out-of-band management interface port", "name": "port", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { "description": "the operation result description", "name": "description", "type": "string" - }, - {}, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" } ], "since": "4.9.0" @@ -10034,24 +10609,23 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, { @@ -10059,22 +10633,23 @@ "name": "poolid", "type": "long" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the storage tag", "name": "name", "type": "string" }, { - "description": "the ID of the storage tag", - "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" - }, - {} + } ] }, { @@ -10092,12 +10667,6 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -10113,7 +10682,13 @@ "name": "success", "type": "boolean" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -10133,42 +10708,42 @@ "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 template ID", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, + {}, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" }, - { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + {} ] }, { @@ -10188,14 +10763,9 @@ "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 last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { "description": "the link local netmask for the system vm", @@ -10203,99 +10773,100 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "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 private netmask for the system VM", - "name": "privatenetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the system VM", - "name": "state", + "description": "the Pod ID for the system VM", + "name": "podid", "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 gateway for the system VM", - "name": "gateway", + "description": "the template name for the system VM", + "name": "templatename", "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", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -10303,15 +10874,14 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -10320,48 +10890,43 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "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 first DNS for the system VM", - "name": "dns1", + "description": "the template ID for the system VM", + "name": "templateid", "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 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 name of the system VM", - "name": "name", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -10370,19 +10935,29 @@ "type": "boolean" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { "description": "the agent state of the system VM", "name": "agentstate", "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" } ] }, @@ -10392,26 +10967,13 @@ "name": "listAnnotations", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the id of the entity for which to show annotations", + "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": "entityid", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "optional: the id of the user of the annotation", "length": 255, @@ -10428,61 +10990,62 @@ "type": "string" }, { - "description": "the entity type", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "entitytype", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the id of the annotation", + "description": "the entity type", "length": 255, - "name": "id", + "name": "entitytype", "required": false, "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": "", "length": 255, - "name": "annotationfilter", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the id of the annotation", + "length": 255, + "name": "id", "required": false, - "since": "4.16.0", "type": "string" } ], "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", "response": [ - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the contents of the annotation", + "name": "annotation", "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 (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { "description": "the type of the annotated entity", @@ -10490,30 +11053,42 @@ "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { "description": "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 name of the entitiy to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "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" + }, + {} ], "since": "4.11" }, @@ -10523,30 +11098,30 @@ "name": "addSwift", "params": [ { - "description": "the account for swift", + "description": "the username for swift", "length": 255, - "name": "account", + "name": "username", "required": false, "type": "string" }, { - "description": " key for the user for swift", + "description": "the URL for swift", "length": 255, - "name": "key", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "the URL for swift", + "description": " key for the user for swift", "length": 255, - "name": "url", - "required": true, + "name": "key", + "required": false, "type": "string" }, { - "description": "the username for swift", + "description": "the account for swift", "length": 255, - "name": "username", + "name": "account", "required": false, "type": "string" } @@ -10559,29 +11134,25 @@ "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, + {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { @@ -10590,23 +11161,33 @@ "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the 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", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -10615,15 +11196,9 @@ "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 name of the image store", + "name": "name", + "type": "string" } ], "since": "3.0.0" @@ -10634,19 +11209,18 @@ "name": "archiveEvents", "params": [ { - "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "archive by event type", "length": 255, - "name": "startdate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { - "description": "the IDs of the events", + "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": "ids", - "related": "listEvents", + "name": "startdate", "required": false, - "type": "list" + "type": "date" }, { "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -10656,26 +11230,22 @@ "type": "date" }, { - "description": "archive by event type", + "description": "the IDs of the events", "length": 255, - "name": "type", + "name": "ids", + "related": "listEvents", "required": false, - "type": "string" + "type": "list" } ], "response": [ - {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -10685,6 +11255,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" } ] }, @@ -10703,27 +11278,27 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.2.0" @@ -10734,30 +11309,30 @@ "name": "addSrxFirewall", "params": [ { - "description": "Credentials to reach SRX firewall device", + "description": "supports only JuniperSRXFirewall", "length": 255, - "name": "password", + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "URL of the SRX appliance.", + "description": "Credentials to reach SRX firewall device", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach SRX firewall device", + "description": "URL of the SRX appliance.", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, { - "description": "supports only JuniperSRXFirewall", + "description": "Credentials to reach SRX firewall device", "length": 255, - "name": "networkdevicetype", + "name": "password", "required": true, "type": "string" }, @@ -10772,29 +11347,24 @@ ], "related": "configureSrxFirewall", "response": [ - { - "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 public security zone of the external firewall", - "name": "publiczone", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, {}, @@ -10804,54 +11374,58 @@ "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "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 number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, - {}, { "description": "the private interface of the external firewall", "name": "privateinterface", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10859,10 +11433,11 @@ "name": "provider", "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" } ] }, @@ -10871,11 +11446,19 @@ "isasync": true, "name": "updateLoadBalancer", "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "the ID of the load balancer", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -10886,65 +11469,10 @@ "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": "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", - "type": "integer" - }, - { - "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", @@ -10954,6 +11482,11 @@ "name": "id", "type": "string" }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, { "description": "the ip address of the instance", "name": "ipaddress", @@ -10963,42 +11496,22 @@ "description": "the state of the instance", "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", - "type": "string" - }, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "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" }, { @@ -11006,47 +11519,84 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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 account associated with the tag", + "name": "account", "type": "string" + } + ], + "type": "list" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "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": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { @@ -11054,15 +11604,14 @@ "name": "id", "type": "string" }, - {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -11071,16 +11620,42 @@ "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, - {} + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "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", + "type": "string" + }, + {}, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + } ], "since": "4.4.0" }, @@ -11090,18 +11665,18 @@ "name": "scaleSystemVm", "params": [ { - "description": "the service offering ID to apply to the system vm", + "description": "The ID of the system vm", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" }, { - "description": "The ID of the system vm", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, @@ -11116,71 +11691,69 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the state of the system VM", + "name": "state", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", - "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", @@ -11188,33 +11761,33 @@ "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 name of the system VM", - "name": "name", + "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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "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 link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -11223,18 +11796,18 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "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 link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "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" }, { @@ -11243,48 +11816,44 @@ "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, + {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -11293,24 +11862,30 @@ "type": "integer" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "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": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -11319,11 +11894,18 @@ "isasync": false, "name": "listSnapshotPolicies", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "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" }, @@ -11335,17 +11917,10 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -11360,7 +11935,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -11368,17 +11943,17 @@ "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -11387,13 +11962,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -11402,13 +11972,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -11417,21 +11987,26 @@ "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", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { @@ -11439,43 +12014,43 @@ "name": "maxsnaps", "type": "int" }, - {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "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": "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 ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - {} + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + } ] }, { @@ -11483,20 +12058,6 @@ "isasync": true, "name": "updateVpnCustomerGateway", "params": [ - { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" - }, - { - "description": "Force encapsulation for Nat Traversal", - "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" - }, { "description": "name of this customer gateway", "length": 255, @@ -11505,20 +12066,18 @@ "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "esppolicy", + "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": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "name": "ipsecpsk", + "required": true, + "type": "string" }, { "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", @@ -11528,12 +12087,11 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikeversion", + "name": "esplifetime", "required": false, - "since": "4.15.1", - "type": "string" + "type": "long" }, { "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", @@ -11543,25 +12101,33 @@ "type": "long" }, { - "description": "Lifetime of phase 2 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": "esplifetime", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "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": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "ipsecpsk", - "required": true, + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { @@ -11579,80 +12145,96 @@ "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": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "id of customer gateway", "length": 255, - "name": "account", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": true, + "type": "uuid" + }, + { + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ { - "description": "the vpn gateway ID", - "name": "id", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the owner", - "name": "account", - "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": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, { "description": "IPsec policy of customer gateway", "name": "esppolicy", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the project name", + "name": "project", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, + {}, + {}, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -11661,19 +12243,19 @@ "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { "description": "if DPD is enabled for customer gateway", @@ -11681,36 +12263,29 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, - {}, - {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the customer gateway", + "name": "name", + "type": "string" } ] }, @@ -11720,31 +12295,26 @@ "name": "lockAccount", "params": [ { - "description": "Locks the specified account on this domain.", + "description": "Locks the specified account.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Locks the specified account.", + "description": "Locks the specified account on this domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, - "type": "string" + "type": "uuid" } ], "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -11752,107 +12322,77 @@ "name": "vpcavailable", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "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 volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "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 total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", - "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 number of snapshots available for this account", - "name": "snapshotavailable", + "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 network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { "description": "the total number of templates available to be created by this account", @@ -11860,29 +12400,24 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { "description": "the state of the account", @@ -11890,39 +12425,39 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "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 id of the account", - "name": "id", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "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", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { "description": "the total number of virtual machines deployed by this account", @@ -11930,92 +12465,122 @@ "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "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", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "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": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "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 volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ + { + "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 domain ID of the user", - "name": "domainid", + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -12024,13 +12589,13 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -12039,18 +12604,18 @@ "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -12058,6 +12623,11 @@ "name": "email", "type": "string" }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, { "description": "the user state", "name": "state", @@ -12066,11 +12636,11 @@ { "description": "the account type of the user", "name": "accounttype", - "type": "short" + "type": "integer" }, { - "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" }, { @@ -12079,23 +12649,8 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -12104,57 +12659,77 @@ "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" } ], "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { "description": "the total primary storage space (in GiB) the account can own", "name": "primarystoragelimit", "type": "string" }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" } ] }, @@ -12182,82 +12757,87 @@ "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { "description": "the Secondary ipv4 addr of nic", "name": "secondaryip", "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -12266,19 +12846,19 @@ "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "the ID of the corresponding network", @@ -12286,119 +12866,77 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "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 link local IP address for the router", - "name": "linklocalip", + "description": "the guest netmask for the router", + "name": "guestnetmask", "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" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { "description": "the ID of the corresponding guest network", @@ -12406,49 +12944,30 @@ "type": "string" }, { - "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 template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { "description": "the first DNS for the router", @@ -12456,88 +12975,93 @@ "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of scripts", + "name": "scriptsversion", "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 account associated with the router", - "name": "account", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -12546,28 +13070,34 @@ "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, + {}, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { @@ -12575,37 +13105,87 @@ "name": "state", "type": "state" }, - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, { "description": "the UUID of the latest async job acting on 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 version of template", + "name": "version", + "type": "string" + }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "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 version of template", - "name": "version", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -12615,19 +13195,35 @@ "name": "listClusters", "params": [ { - "description": "List by keyword", + "description": "lists clusters by Zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by allocation state", "length": 255, - "name": "managedstate", + "name": "allocationstate", "required": false, "type": "string" }, + { + "description": "lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -12636,9 +13232,9 @@ "type": "integer" }, { - "description": "lists clusters by hypervisor type", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "hypervisor", + "name": "managedstate", "required": false, "type": "string" }, @@ -12651,53 +13247,37 @@ "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists clusters by allocation state", + "description": "List by keyword", "length": 255, - "name": "allocationstate", + "name": "keyword", "required": false, "type": "string" }, { - "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", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" - }, - { - "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", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" } @@ -12705,23 +13285,23 @@ "related": "addCluster,updateCluster", "response": [ { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { @@ -12730,13 +13310,39 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", "type": "string" }, { @@ -12744,10 +13350,25 @@ "name": "resourcedetails", "type": "map" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the percentage of capacity currently in use", "name": "percentused", @@ -12759,28 +13380,23 @@ "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -12788,16 +13404,6 @@ "name": "capacityused", "type": "long" }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, { "description": "the capacity currently in allocated", "name": "capacityallocated", @@ -12807,56 +13413,30 @@ "description": "the Pod name", "name": "podname", "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, + {}, { "description": "the Zone ID of the cluster", "name": "zoneid", "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - {}, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -12876,9 +13456,14 @@ ], "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", @@ -12888,14 +13473,9 @@ {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -12906,26 +13486,33 @@ "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 invitations by state", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list by project id", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "list invitations by id", @@ -12936,18 +13523,19 @@ "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": "list invitations by state", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -12957,18 +13545,18 @@ "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", + "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 invitation by user ID", @@ -12979,19 +13567,11 @@ "type": "uuid" }, { - "description": "list by project id", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "pagesize", + "name": "activeonly", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", @@ -13001,36 +13581,34 @@ "name": "email", "type": "string" }, - {}, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "the name of the project", + "name": "project", "type": "string" }, { - "description": "the id of the invitation", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the invitation", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the User ID", + "name": "userid", + "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, { @@ -13038,10 +13616,11 @@ "name": "domainid", "type": "string" }, + {}, { - "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 invitation state", @@ -13049,10 +13628,11 @@ "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "projectid", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -13062,108 +13642,108 @@ "name": "listEgressFirewallRules", "params": [ { - "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": "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": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of IP address of the firewall services", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the network ID for the egress firewall services", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "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" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -13171,57 +13751,31 @@ "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "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 public ip address for the firewall rule", - "name": "ipaddress", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "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", @@ -13233,13 +13787,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -13247,53 +13801,84 @@ "name": "project", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "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", + "name": "icmptype", + "type": "integer" }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, { "description": "the ending port of firewall rule's port range", "name": "endport", "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -13326,26 +13911,30 @@ ], "related": "addRegion,listRegions", "response": [ - {}, { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "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" }, { @@ -13354,15 +13943,11 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - } + {} ] }, { @@ -13380,6 +13965,11 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -13390,17 +13980,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, {} ], "since": "3.0.0" @@ -13411,16 +13996,9 @@ "name": "listClustersMetrics", "params": [ { - "description": "lists clusters by hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "lists clusters by cluster type", + "description": "List by keyword", "length": 255, - "name": "clustertype", + "name": "keyword", "required": false, "type": "string" }, @@ -13432,16 +14010,16 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by allocation state", "length": 255, - "name": "name", + "name": "allocationstate", "required": false, "type": "string" }, @@ -13453,20 +14031,11 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "lists clusters by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "lists clusters by Pod ID", @@ -13484,25 +14053,62 @@ "type": "integer" }, { - "description": "", + "description": "lists clusters by cluster type", "length": 255, - "name": "page", + "name": "clustertype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "allocationstate", + "name": "id", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", "required": false, "type": "string" + }, + { + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + {}, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { @@ -13511,13 +14117,23 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { @@ -13525,11 +14141,10 @@ "name": "memoryallocateddisablethreshold", "type": "boolean" }, - {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { "description": "the maximum memory deviation", @@ -13537,28 +14152,33 @@ "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { @@ -13567,93 +14187,88 @@ "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the cluster name", + "name": "name", + "type": "string" }, - {}, { "description": "running / total hosts in the cluster", "name": "hosts", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the cluster ID", "name": "id", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -13662,19 +14277,19 @@ "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { "description": "the capacity type", @@ -13682,67 +14297,37 @@ "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "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 capacity name", - "name": "name", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" } ], "type": "list" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" } ], "since": "4.9.3" @@ -13752,14 +14337,6 @@ "isasync": false, "name": "listProjectRolePermissions", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project", "length": 255, @@ -13767,28 +14344,26 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" } ], "related": "createProjectRolePermission", "response": [ { - "description": "the 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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { @@ -13796,172 +14371,40 @@ "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", - "type": "string" }, {}, {}, { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "account id", - "name": "accountid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "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", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, - { - "description": "backed up volumes", - "name": "volumes", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" } ], - "since": "4.14.0" + "since": "4.15.0" }, { "description": "Lists all LDAP configurations", @@ -13976,17 +14419,10 @@ "required": false, "type": "uuid" }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -13997,13 +14433,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, @@ -14012,26 +14441,40 @@ "since": "4.13.2", "type": "boolean" }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ {}, { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "linked domain", @@ -14039,16 +14482,16 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" + }, + {} ], "since": "4.2.0" }, @@ -14058,46 +14501,46 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the Zone ID for the staging store", + "description": "the name of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the staging store", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "the ID of the staging store", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -14119,19 +14562,19 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, {}, { @@ -14140,21 +14583,10 @@ "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 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", @@ -14165,20 +14597,26 @@ "name": "readonly", "type": "boolean" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the ID of the image store", @@ -14186,9 +14624,14 @@ "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" } ], "since": "4.2.0" @@ -14198,13 +14641,6 @@ "isasync": true, "name": "createRemoteAccessVpn", "params": [ - { - "description": "an optional account for the VPN. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -14214,12 +14650,11 @@ "type": "boolean" }, { - "description": "public ip address id of the vpn server", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", @@ -14229,6 +14664,13 @@ "required": false, "type": "uuid" }, + { + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "length": 255, + "name": "iprange", + "required": false, + "type": "string" + }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default", "length": 255, @@ -14237,44 +14679,46 @@ "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", - "required": false, - "type": "string" + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "response": [ + {}, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the project name of the vpn", + "name": "project", "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": "publicip", + "type": "string" }, { "description": "the state of the rule", @@ -14282,25 +14726,30 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ipsec preshared key", "name": "presharedkey", "type": "string" }, + { + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" + }, { "description": "the project id of the vpn", "name": "projectid", @@ -14308,16 +14757,10 @@ }, {}, { - "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" - }, - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - {} + } ] }, { @@ -14337,49 +14780,38 @@ "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", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of template", + "name": "version", "type": "string" }, { @@ -14388,88 +14820,85 @@ "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the 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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "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": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -14478,18 +14907,18 @@ "type": "state" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the second DNS for the router", + "name": "dns2", "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 domain ID associated with the router", - "name": "domainid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -14497,122 +14926,14 @@ "name": "publicnetworkid", "type": "string" }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, { "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "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 guest netmask for the router", - "name": "guestnetmask", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -14620,80 +14941,80 @@ "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, { "description": "the name of the corresponding network", "name": "networkname", @@ -14705,263 +15026,414 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" - } - ] - }, - { - "description": "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'.", - "isasync": false, - "name": "changeServiceForVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, - { - "description": "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 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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, + {}, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", + "description": "the public IP address for the router", "name": "publicip", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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 project name of the vm", - "name": "project", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of the template for the virtual machine", + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the template name for the router", "name": "templatename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" + } + ] + }, + { + "description": "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'.", + "isasync": false, + "name": "changeServiceForVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "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": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "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 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "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": "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -14970,23 +15442,38 @@ "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the gateway of the nic", "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -14994,6 +15481,16 @@ "name": "isolationuri", "type": "string" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, { "description": "the gateway of IPv6 network", "name": "ip6gateway", @@ -15005,33 +15502,33 @@ "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "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": "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 netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -15040,14 +15537,14 @@ "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -15055,51 +15552,99 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the speed of each cpu", + "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -15108,217 +15653,138 @@ "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the 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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "set" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "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", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "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": "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" }, { @@ -15327,8 +15793,13 @@ "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", "type": "string" }, { @@ -15337,13 +15808,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -15352,26 +15823,21 @@ "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": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -15380,17 +15846,37 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -15399,9 +15885,9 @@ "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", @@ -15409,47 +15895,126 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -15458,98 +16023,127 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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" } ], "type": "set" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, - {}, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -15558,193 +16152,79 @@ "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "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": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the 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", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" } ] }, @@ -15754,26 +16234,26 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "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 Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -15786,17 +16266,10 @@ "type": "uuid" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, - "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" }, @@ -15807,20 +16280,24 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" + }, + { + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listConfigurations,updateConfiguration", "response": [ + {}, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" - }, - { - "description": "the description of the configuration", - "name": "description", + "description": "the category of the configuration", + "name": "category", "type": "string" }, + {}, { "description": "the value of the configuration", "name": "id", @@ -15831,26 +16308,29 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "the name of the configuration", - "name": "name", - "type": "string" - }, { "description": "true if the configuration is dynamic", "name": "isdynamic", "type": "boolean" }, + { + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the name of the configuration", + "name": "name", + "type": "string" + }, + { + "description": "the description of the configuration", + "name": "description", "type": "string" }, { @@ -15873,6 +16353,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list mapping by its UUID", "length": 255, @@ -15882,19 +16369,19 @@ "type": "uuid" }, { - "description": "list mapping by Guest OS Type UUID", + "description": "", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "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", @@ -15904,46 +16391,39 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the hypervisor", - "name": "hypervisor", + "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", + "name": "id", + "type": "string" }, {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "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": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -15952,21 +16432,21 @@ "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.4.0" }, @@ -15975,20 +16455,6 @@ "isasync": false, "name": "listTemplates", "params": [ - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -16003,41 +16469,32 @@ "required": true, "type": "string" }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the template ID", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "showunique", "required": false, - "type": "uuid" + "since": "4.13.2", + "type": "boolean" }, { - "description": "list objects by project", + "description": "the template name", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the template name", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, @@ -16049,12 +16506,12 @@ "type": "boolean" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "details", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.15", - "type": "list" + "type": "uuid" }, { "description": "show removed templates as well", @@ -16064,103 +16521,116 @@ "type": "boolean" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "tags", "required": false, - "since": "4.9", - "type": "list" + "type": "map" }, { - "description": "list templates by zoneId", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "If set to true, list only unique templates across zones", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showunique", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "list datadisk templates by parent template 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": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "listall", "required": false, - "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the template ID", "length": 255, - "name": "tags", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list templates by zoneId", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "listall", + "name": "details", "required": false, - "type": "boolean" + "since": "4.15", + "type": "list" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "the IDs of the templates, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "since": "4.9", + "type": "list" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the URL which the template/iso is registered from", + "name": "url", "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 this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "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" }, { @@ -16169,25 +16639,14 @@ "type": "string" }, { - "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 status of the template", + "name": "status", "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", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { "description": "true if the template is managed across all Zones, false otherwise", @@ -16195,33 +16654,38 @@ "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -16230,76 +16694,162 @@ "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, + { + "description": "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": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "true if 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 OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "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 domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + {}, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + {}, { "description": "the list of resource tags associated", "name": "tags", @@ -16310,18 +16860,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -16330,107 +16880,37 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "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": "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 project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "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" } ] }, @@ -16440,11 +16920,12 @@ "name": "createAutoScalePolicy", "params": [ { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", @@ -16454,12 +16935,11 @@ "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" + "name": "quiettime", + "required": false, + "type": "integer" }, { "description": "the duration for which the conditions have to be true before action is taken", @@ -16472,21 +16952,25 @@ "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { "description": "the project id autoscale policy", "name": "projectid", @@ -16499,15 +16983,16 @@ "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, + {}, { "description": "the account owning the autoscale policy", "name": "account", @@ -16524,14 +17009,9 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", "type": "integer" - }, - { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" } ] }, @@ -16544,7 +17024,7 @@ "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" } @@ -16555,24 +17035,111 @@ "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + {} + ] + }, + { + "description": "Lists 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 last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the 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 time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Enables HA for a zone", + "isasync": true, + "name": "enableHAForZone", + "params": [ + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" } - ] + ], + "since": "4.11" }, { "description": "Lists physical networks", @@ -16580,77 +17147,70 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "List by keyword", + "description": "list physical network by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "search by name", + "description": "the Zone ID for the physical network", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "search by name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list physical network by id", + "description": "", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "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", + "description": "name of the physical network", + "name": "name", "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", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16659,82 +17219,49 @@ "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the vlan of the physical network", "name": "vlan", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain id of the physical network owner", "name": "domainid", "type": "string" }, + {}, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", - "params": [ - { - "description": "ID of the zone", - "length": 255, + "description": "zone id of the physical network", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" } ], - "since": "4.11" + "since": "3.0.0" }, { "description": "Lists all firewall rules for an IP address.", @@ -16742,33 +17269,26 @@ "name": "listFirewallRules", "params": [ { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "keyword", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -16777,13 +17297,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -16800,15 +17313,6 @@ "required": false, "type": "uuid" }, - { - "description": "list firewall rules for certain network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" - }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -16817,112 +17321,63 @@ "type": "map" }, { - "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", + "description": "List by keyword", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project", + "description": "list firewall rules for certain network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "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 public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" }, - {}, { - "description": "the ID of the firewall rule", + "description": "Lists rule with the specified ID.", + "length": 255, "name": "id", - "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": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + } + ], + "related": "createFirewallRule,updateEgressFirewallRule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", @@ -16933,11 +17388,6 @@ "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", @@ -16949,8 +17399,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -16964,17 +17414,99 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" + }, + {}, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -16984,16 +17516,14 @@ "name": "cleanVMReservations", "params": [], "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" }, { @@ -17001,6 +17531,8 @@ "name": "success", "type": "boolean" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -17023,11 +17555,7 @@ } ], "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", @@ -17035,15 +17563,19 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -17053,11 +17585,12 @@ "name": "extractIso", "params": [ { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the ISO file", "length": 255, - "name": "mode", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the ID of the zone where the ISO is originally located", @@ -17068,12 +17601,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", @@ -17086,24 +17618,24 @@ "related": "extractTemplate,extractVolume", "response": [ { - "description": "the state of the extracted object", - "name": "state", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { "description": "the id of extracted object", @@ -17111,62 +17643,62 @@ "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "zone name the object was extracted from", + "name": "zonename", "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", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, - {}, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the extracted object", + "name": "name", + "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": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" - } + }, + {}, + {} ] }, { @@ -17175,19 +17707,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,77 +17728,76 @@ "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", - "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 url of the image store", + "name": "url", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, { - "description": "the name of the image store", - "name": "name", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the 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 protocol of the image store", - "name": "protocol", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -17276,15 +17806,17 @@ "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" - } + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -17293,27 +17825,19 @@ "name": "createAffinityGroup", "params": [ { - "description": "an account for the affinity group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "domainId of the account owning the affinity group", + "description": "create affinity group for 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": "create affinity group for project", + "description": "optional description of the affinity group", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Type of the affinity group from the available affinity/anti-affinity group types", @@ -17323,9 +17847,17 @@ "type": "string" }, { - "description": "optional description of the affinity group", + "description": "domainId of the account owning the affinity group", "length": 255, - "name": "description", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -17339,16 +17871,20 @@ ], "related": "", "response": [ - {}, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { "description": "the name of the affinity group", @@ -17356,24 +17892,19 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 ID of the affinity group", + "name": "id", "type": "string" }, { @@ -17382,23 +17913,24 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, + {}, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ] @@ -17418,17 +17950,16 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -17439,7 +17970,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -17448,63 +17980,68 @@ "name": "listInternalLoadBalancerElements", "params": [ { - "description": "list internal load balancer elements by network service provider id", + "description": "List by keyword", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list internal load balancer elements by id", + "description": "list internal load balancer elements by enabled state", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list internal load balancer elements by network service provider id", "length": 255, - "name": "page", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list internal load balancer elements by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list internal load balancer elements by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement", + "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", "response": [ - {}, - {}, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -17512,14 +18049,9 @@ "type": "string" }, { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -17529,14 +18061,6 @@ "isasync": true, "name": "updateLBHealthCheckPolicy", "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, @@ -17552,33 +18076,61 @@ "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", "required": true, "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, {}, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, { "description": "the 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": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "the state of the policy", - "name": "state", + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { @@ -17587,14 +18139,14 @@ "type": "int" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { "description": "Number of consecutive health check success before declaring an instance healthy", @@ -17602,51 +18154,71 @@ "type": "int" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" } ], "type": "list" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, + {}, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], - "since": "4.4" + "since": "4.11" }, { "description": "Reboots a virtual machine.", @@ -17654,12 +18226,12 @@ "name": "rebootVirtualMachine", "params": [ { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "The ID of the virtual machine", "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { "description": "Boot into hardware setup menu or not", @@ -17670,330 +18242,494 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "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", + "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "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", - "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the 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", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the 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" + "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": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account owning the affinity group", + "name": "account", "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 domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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 template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", + "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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": "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": "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": "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "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.", @@ -18001,143 +18737,185 @@ "type": "map" }, { - "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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": "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the memory used by the vm", + "description": "the memory used by the VM in KiB", "name": "memorykbs", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, + {}, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Guest vm Boot Type", + "name": "boottype", "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -18146,574 +18924,329 @@ "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": "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 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": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the security group", + "description": "the IPv6 address of network", + "name": "ip6address", + "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 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" - } - ], - "type": "set" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 availablility zone for the virtual machine", - "name": "zoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the 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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the 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 user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" } ] }, { - "description": "Enables HA cluster-wide", + "description": "Creates a load balancer rule", "isasync": true, - "name": "enableHAForCluster", + "name": "createLoadBalancerRule", "params": [ { - "description": "ID of the cluster", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "Creates a load balancer rule", - "isasync": true, - "name": "createLoadBalancerRule", - "params": [ - { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "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 domain ID associated with the load balancer", "length": 255, - "name": "openfirewall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "name of the load balancer rule", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "algorithm", + "name": "publicport", "required": true, - "type": "string" + "type": "integer" }, { "description": "the description of the load balancer rule", @@ -18723,17 +19256,24 @@ "type": "string" }, { - "description": "name of the load balancer rule", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "name", - "required": true, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "protocol", - "required": false, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { @@ -18752,46 +19292,33 @@ "type": "uuid" }, { - "description": "the domain ID associated with the load balancer", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "the public port from where the network traffic will be load balanced from", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "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)", + "description": "an optional field, whether to the display the rule to the end user or not", "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" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -18799,62 +19326,7 @@ "name": "fordisplay", "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" - }, - { - "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", @@ -18865,13 +19337,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -18885,18 +19357,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -18905,97 +19377,81 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "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 public port", + "name": "publicport", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "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": "the domain of the load balancer rule", + "name": "domain", + "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the name of the load balancer", + "name": "name", "type": "string" - } - ] - }, - { - "description": "Import vSphere storage policies", - "isasync": false, - "name": "importVsphereStoragePolicies", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "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" }, - {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, - {}, { - "description": "the ID of the Storage Policy", + "description": "the load balancer rule ID", "name": "id", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -19004,71 +19460,57 @@ "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" - } - ] - }, - { - "description": "Lists backup offerings", - "isasync": false, - "name": "listBackupOfferings", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "The zone ID", - "length": 255, + "description": "the id of the zone the rule belongs to", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The backup offering ID", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", - "required": false, - "type": "uuid" + "description": "the description of the load balancer", + "name": "description", + "type": "string" }, { - "description": "", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {} + ] + }, + { + "description": "Import vSphere storage policies", + "isasync": false, + "name": "importVsphereStoragePolicies", + "params": [ + { + "description": "ID of the zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], - "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", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { @@ -19076,39 +19518,29 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "zone ID", - "name": "zoneid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" - }, - {}, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" } - ], - "since": "4.14.0" + ] }, { "description": "Adds a guest OS name to hypervisor OS name mapping", @@ -19116,12 +19548,20 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", "length": 255, - "name": "hypervisorversion", + "name": "hypervisor", "required": true, "type": "string" }, + { + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + }, { "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, @@ -19137,69 +19577,61 @@ "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": true, "type": "string" } ], "related": "updateGuestOsMapping", "response": [ + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "is the mapping user defined", + "name": "isuserdefined", "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", "name": "id", "type": "string" - }, - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" } ], "since": "4.4.0" @@ -19220,61 +19652,61 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface username", + "name": "username", "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 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" }, { - "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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -19283,111 +19715,38 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" }, { - "description": "configures a F5 load balancer device", - "isasync": true, - "name": "configureF5LoadBalancer", + "description": "Updates a network offering.", + "isasync": false, + "name": "updateNetworkOffering", "params": [ { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "description": "update state for the network offering", "length": 255, - "name": "lbdevicecapacity", + "name": "state", "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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "device id of the F5 load balancer", - "name": "lbdeviceid", - "type": "string" - }, - {}, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", "type": "string" }, { - "description": "the physical network to which this F5 device belongs to", - "name": "physicalnetworkid", + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, - {}, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - } - ] - }, - { - "description": "Updates a network offering.", - "isasync": false, - "name": "updateNetworkOffering", - "params": [ { - "description": "update state for the network offering", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "state", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -19398,23 +19757,16 @@ "type": "string" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", "length": 255, - "name": "domainid", + "name": "keepaliveenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", + "description": "the name of the network offering", "length": 255, - "name": "availability", + "name": "name", "required": false, "type": "string" }, @@ -19426,25 +19778,25 @@ "type": "integer" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "keepaliveenabled", + "name": "domainid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", "length": 255, - "name": "maxconnections", + "name": "availability", "required": false, - "type": "integer" + "type": "string" }, { "description": "the id of the network offering", @@ -19453,53 +19805,137 @@ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" } ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, { "description": "true if network offering can be used by VPC networks only", "name": "forvpc", "type": "boolean" }, - {}, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, { "description": "true if network offering supports public access for guest networks", "name": "supportspublicaccess", "type": "boolean" }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, { "description": "data transfer rate in megabits per second allowed.", "name": "networkrate", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the network offering", + "name": "tags", "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 traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + {}, + { + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the date this network 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 list of supported services", "name": "service", @@ -19508,16 +19944,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 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", @@ -19535,6 +19971,11 @@ "description": "the service provider name", "name": "provider", "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -19546,28 +19987,23 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", + "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": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -19577,59 +20013,109 @@ "type": "list" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { "description": "guest type of the network offering, can be Shared or Isolated", "name": "guestiptype", "type": "string" }, - {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" + } + ] + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the gateway for the system VM", + "name": "gateway", + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -19638,128 +20124,89 @@ "type": "integer" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, + {}, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the systemvm agent version", + "name": "version", + "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the id of the network offering", + "description": "the ID of the system VM", "name": "id", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" - } - ] - }, - { - "description": "Create VM backup", - "isasync": true, - "name": "createBackup", - "params": [ - { - "description": "ID of the VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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", + "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 date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", "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 link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { @@ -19773,181 +20220,44 @@ "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "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 name of the system VM", + "name": "name", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "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 name of the system VM", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "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", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" - }, - {}, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" } ] }, @@ -19960,19 +20270,24 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + {}, + { + "description": "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", @@ -19982,11 +20297,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -19996,20 +20306,12 @@ "name": "updateVPC", "params": [ { - "description": "the name of the VPC", + "description": "the display text of the VPC", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, - { - "description": "the id of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, @@ -20019,36 +20321,50 @@ "type": "boolean" }, { - "description": "the display text of the VPC", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "displaytext", + "name": "customid", "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": "the id of the VPC", "length": 255, - "name": "customid", + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the VPC", + "length": 255, + "name": "name", "required": false, - "since": "4.4", "type": "string" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the VPC", + "name": "id", "type": "string" }, { @@ -20057,104 +20373,23 @@ "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the id of the VPC", - "name": "id", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -20163,24 +20398,14 @@ "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the zone the VPC belongs to", @@ -20188,14 +20413,9 @@ "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": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { "description": "the domain name of the owner", @@ -20208,32 +20428,96 @@ "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, - {}, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "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": "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, - {}, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "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 list of resource tags associated with the project", "name": "tags", @@ -20244,8 +20528,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -20254,52 +20538,83 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, { "description": "zone id of the vpc", "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + {}, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" } ] }, @@ -20319,7 +20634,7 @@ "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" } @@ -20332,30 +20647,38 @@ "type": "string" }, { - "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 address", + "name": "address", "type": "string" }, - {}, { "description": "the out-of-band management driver for the host", "name": "driver", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, - {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -20363,124 +20686,123 @@ "name": "username", "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management 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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" } ], "since": "4.9.0" }, { - "description": "List resource detail(s)", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listResourceDetails", + "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", + "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 resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.3", - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list by key", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "key", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list objects by project", + "description": "Lists ipv6 firewall rule with the specified ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "list by resource type", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "list by resource id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourceid", + "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "value", + "name": "fordisplay", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -20488,350 +20810,708 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" } ], - "related": "listTags", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, - { - "description": "the 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": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, - {}, { - "description": "resource type", - "name": "resourcetype", + "description": "the 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" - } - ], - "since": "4.2" - }, - { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", - "params": [ - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedClusters", - "response": [ - {}, - { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", + "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 VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, - {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "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": "Creates a network offering.", + "description": "List resource detail(s)", "isasync": false, - "name": "createNetworkOffering", + "name": "listResourceDetails", "params": [ { - "description": "the name of the network offering", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "list by resource id", "length": 255, - "name": "enable", + "name": "resourceid", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "description": "list by key", "length": 255, - "name": "details", + "name": "key", "required": false, - "since": "4.2.0", - "type": "map" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "serviceproviderlist", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "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": "", "length": 255, - "name": "keepaliveenabled", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "if set to true, only details marked with display=true, are returned. False by default", + "length": 255, + "name": "fordisplay", "required": false, + "since": "4.3", "type": "boolean" }, { - "description": "the availability of network offering. Default value is Optional", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "availability", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if network offering supports vlans", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "specifyvlan", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "value", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "list by resource type", "length": 255, - "name": "guestiptype", + "name": "resourcetype", "required": true, "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "List by keyword", "length": 255, - "name": "ispersistent", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "", "length": 255, - "name": "egressdefaultpolicy", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" + } + ], + "related": "listTags", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": true, + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "since": "4.2" + }, + { + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", + "params": [ + { + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "since": "4.13", - "type": "list" + "type": "uuid" }, { - "description": "true if the network offering is IP conserve mode enabled", + "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": "conservemode", + "name": "forced", "required": false, "type": "boolean" } ], - "related": "listNetworkOfferings", "response": [ { - "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": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.17.0" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the cluster", + "name": "clustername", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + {}, + {}, + { + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Creates a network offering.", + "isasync": false, + "name": "createNetworkOffering", + "params": [ + { + "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 availability of network offering. Default value is Optional", + "length": 255, + "name": "availability", + "required": false, + "type": "string" + }, + { + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "type": "string" + }, + { + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "list" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "length": 255, + "name": "egressdefaultpolicy", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, + "type": "boolean" + }, + { + "description": "true if the network offering is IP conserve mode enabled", + "length": 255, + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, + { + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, + { + "description": "services supported by the network offering", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, + { + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "length": 255, + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" + }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "true if network offering supports vlans", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" + }, + { + "description": "desired service capabilities as part of network offering", + "length": 255, + "name": "servicecapabilitylist", + "required": false, + "type": "map" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + } + ], + "related": "listNetworkOfferings", + "response": [ + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "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": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "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", @@ -20841,11 +21521,6 @@ "description": "the capability name", "name": "name", "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" @@ -20855,9 +21530,9 @@ "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", @@ -20865,70 +21540,65 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "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": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "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", + "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "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", @@ -20936,15 +21606,19 @@ "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, - {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { "description": "availability of the network offering", @@ -20952,19 +21626,14 @@ "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" }, { "description": "true if network offering is ip conserve mode enabled", @@ -20972,71 +21641,31 @@ "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": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "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": "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", + "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 network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -21052,6 +21681,13 @@ "required": false, "type": "list" }, + { + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, { "description": "the start port for the rule", "length": 255, @@ -21066,13 +21702,6 @@ "required": false, "type": "boolean" }, - { - "description": "the protocol for the rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, { "description": "the public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, @@ -21082,32 +21711,73 @@ "type": "uuid" }, { - "description": "the end port for the rule", + "description": "the protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + {}, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -21116,113 +21786,72 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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": "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", - "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 VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the 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 starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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 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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -21231,13 +21860,13 @@ "type": "integer" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" } ] @@ -21248,59 +21877,64 @@ "name": "listVolumesMetrics", "params": [ { - "description": "the pod id the disk volume belongs to", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the disk volume", + "description": "", "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": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.9", - "type": "list" + "type": "uuid" }, { - "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,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list volumes on specified host", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the cluster id the disk volume belongs to", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the name of the disk volume", @@ -21310,35 +21944,35 @@ "type": "string" }, { - "description": "the type of disk volume", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "type", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "integer" + "since": "4.9", + "type": "list" }, { - "description": "the ID of the virtual machine", + "description": "the type of disk volume", "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": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the ID of the availability zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.3", - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -21348,120 +21982,136 @@ "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 objects by project", + "description": "the ID of the virtual machine", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,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,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": "", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "4.3", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list volumes by disk offering", "length": 255, - "name": "account", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "type": "string" + "since": "4.4", + "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": "displayvolume", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "list volumes on specified host", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "list volumes by disk offering", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "displayvolume", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" } ], "related": "", "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the virtual machine", + "name": "vmname", "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": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + {}, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -21469,13 +22119,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -21484,8 +22134,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" }, { @@ -21494,13 +22144,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -21509,57 +22159,52 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "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 total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "the boolean state of whether the volume is destroyed or not", @@ -21567,44 +22212,54 @@ "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 state of the disk volume", + "name": "state", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { "description": "pod id of the volume", @@ -21612,48 +22267,48 @@ "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -21662,155 +22317,134 @@ "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "shared or local storage", + "name": "storagetype", "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": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" } ], @@ -21831,46 +22465,46 @@ ], "related": "listElastistorVolume", "response": [ - { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" - }, { "description": "compression", "name": "compression", "type": "string" }, - {}, { - "description": "the name of the volume", - "name": "name", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, + {}, { "description": "the id of the volume", "name": "id", "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": "deduplication", + "name": "deduplication", + "type": "string" }, { "description": "syncronization", "name": "sync", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" } ] @@ -21881,39 +22515,39 @@ "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": "Map of all possible details and their possible list of values", "name": "details", "type": "map" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.13" }, @@ -21950,7 +22584,7 @@ "description": "Load balancer rule ID", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" } @@ -21958,18 +22592,13 @@ "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": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { @@ -21977,15 +22606,20 @@ "name": "domain", "type": "string" }, + { + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, {}, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -21993,35 +22627,35 @@ "name": "certchain", "type": "string" }, + {}, { - "description": "account for the certificate", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "certificate", - "name": "certificate", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "name", + "name": "name", + "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" } ] @@ -22039,18 +22673,10 @@ "type": "string" }, { - "description": "list gateways by vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -22062,19 +22688,19 @@ "type": "string" }, { - "description": "list private gateway by id", + "description": "list gateways by vpc", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list gateways by state", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -22090,6 +22716,14 @@ "required": false, "type": "boolean" }, + { + "description": "list private gateway by id", + "length": 255, + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -22098,50 +22732,46 @@ "type": "string" }, { - "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 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": "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": "list gateways by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" } ], - "related": "createPrivateGateway", + "related": "createPrivateGateway,createPrivateGateway", "response": [ { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the id of the private gateway", - "name": "id", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { @@ -22149,40 +22779,39 @@ "name": "netmask", "type": "string" }, - {}, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "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": "ACL Id set for private gateway", + "name": "aclid", + "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the project name of the private gateway", - "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 zone the private gateway belongs to", - "name": "zonename", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { @@ -22190,30 +22819,45 @@ "name": "gateway", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "ACL name set for private gateway", "name": "aclname", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, {}, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { @@ -22222,18 +22866,23 @@ "type": "boolean" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the project name of the private gateway", + "name": "project", "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 network implementation uri for the private gateway", - "name": "vlan", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -22262,8 +22911,69 @@ "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -22272,280 +22982,224 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + {}, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the 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 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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - {}, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "the account associated with the virtual machine", "name": "account", "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "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", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name of the group", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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" }, { @@ -22553,18 +23207,8 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -22593,54 +23237,59 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -22649,8 +23298,8 @@ "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -22658,53 +23307,53 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], @@ -22716,12 +23365,32 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -22729,13 +23398,13 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -22744,8 +23413,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -22754,13 +23423,13 @@ "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" }, { @@ -22769,31 +23438,31 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -22802,9 +23471,9 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the code for the ICMP message response", @@ -22812,21 +23481,21 @@ "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -22838,23 +23507,13 @@ "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", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -22863,52 +23522,158 @@ "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the 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 name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of 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 template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -22922,359 +23687,380 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", "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", + "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": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "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", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" + } + ] + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 backup offering of the virtual machine", - "name": "backupofferingid", + "description": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": true, + "type": "uuid" + } + ], + "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "response": [ + { + "description": "the state of the policy", + "name": "state", "type": "string" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "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 LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "Lists all Pods.", + "isasync": false, + "name": "listPods", + "params": [ { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "flag to display the capacity of the pods", + "length": 255, + "name": "showcapacities", + "required": false, "type": "boolean" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "list Pods by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "list Pods by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list Pods by ID", + "length": 255, + "name": "id", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "list pods by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "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", - "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", - "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", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "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": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", - "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" + "type": "integer" }, { - "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": "page", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" } ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "updatePod,createManagementNetworkIpRange", "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 allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { @@ -23282,157 +24068,41 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, - {}, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - } - ], - "type": "list" - } - ], - "since": "4.4" - }, - { - "description": "Lists all Pods.", - "isasync": false, - "name": "listPods", - "params": [ - { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "list Pods by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list Pods by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list Pods by ID", - "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "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", @@ -23443,11 +24113,6 @@ "name": "vlanid", "type": "string" }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, { "description": "indicates if range is dedicated for CPVM and SSVM", "name": "forsystemvms", @@ -23456,65 +24121,18 @@ ], "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", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -23528,29 +24146,29 @@ "type": "short" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod 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 total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { "description": "the capacity name", @@ -23558,22 +24176,63 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" } ], "type": "list" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the 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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" } ] }, @@ -23594,49 +24253,38 @@ "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -23645,141 +24293,136 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "the network domain for the router", + "name": "networkdomain", + "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 link local network", - "name": "linklocalnetworkid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the project name of the address", + "name": "project", "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 Pod ID for the router", - "name": "podid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "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", @@ -23791,24 +24434,29 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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": "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { "description": "the Secondary ipv4 addr of nic", @@ -23816,33 +24464,23 @@ "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -23851,106 +24489,122 @@ "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 traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the ID of the corresponding network", "name": "networkid", "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 name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + {}, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -23959,65 +24613,75 @@ "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, {}, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" } ] }, @@ -24027,9 +24691,9 @@ "name": "updateDiskOffering", "params": [ { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadratemax", "required": false, "since": "4.15", "type": "long" @@ -24050,142 +24714,142 @@ "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "byteswriterate", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "updates alternate display text of the disk offering with this value", "length": 4096, - "name": "domainid", + "name": "displaytext", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the cache mode to use for this disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cachemode", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadrate", + "name": "iopswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "burst io requests write 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": "iopswriteratemax", + "name": "tags", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "zoneid", + "name": "cachemode", "required": false, - "since": "4.13", + "since": "4.15", "type": "string" }, { - "description": "sort key of the disk offering, integer", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "sortkey", + "name": "bytesreadratemax", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopsreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "type": "boolean" + "since": "4.13", + "type": "string" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "bytesreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "byteswriteratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "ID of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "iopsreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "byteswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "tags", + "name": "sortkey", "required": false, - "since": "4.15", - "type": "string" + "type": "integer" }, { - "description": "bytes read rate of the disk offering", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "bytesreadrate", + "name": "zoneid", "required": false, - "since": "4.15", - "type": "long" + "since": "4.13", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "iopswriteratemax", "required": false, "since": "4.15", "type": "long" @@ -24194,38 +24858,48 @@ "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": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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", "type": "string" }, { @@ -24233,12 +24907,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, - {}, { "description": "burst bytes read rate of the disk offering", "name": "diskBytesReadRateMax", @@ -24251,38 +24919,44 @@ }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { "description": "the tags for the disk offering", @@ -24295,55 +24969,55 @@ "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "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.", - "name": "displayoffering", - "type": "boolean" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, - {}, { - "description": "the name of the disk offering", - "name": "name", - "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": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" }, + {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "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", + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "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", + "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 cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -24351,14 +25025,9 @@ "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "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": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { "description": "length (in second) of the burst", @@ -24366,9 +25035,9 @@ "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,28 +25056,28 @@ } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -24431,23 +25100,23 @@ "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" + } ] }, { @@ -24455,6 +25124,13 @@ "isasync": true, "name": "addAccountToProject", "params": [ + { + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, { "description": "email to which invitation to the project is going to be sent", "length": 255, @@ -24471,33 +25147,26 @@ "type": "uuid" }, { - "description": "ID of the project to add the account to", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "name of the account to be added to the project", "length": 255, - "name": "roletype", + "name": "account", "required": false, "type": "string" }, { - "description": "name of the account to be added to the project", + "description": "ID of the project to add the account to", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -24505,17 +25174,17 @@ "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" }, @@ -24525,68 +25194,61 @@ "name": "listSnapshots", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "intervaltype", + "name": "snapshottype", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "lists snapshot by snapshot name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "list snapshots by zone id", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.9", - "type": "list" + "type": "uuid" }, { "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, @@ -24599,7 +25261,14 @@ "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": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -24607,132 +25276,85 @@ "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": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "snapshottype", + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { - "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 snapshots by zone id", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists snapshot by snapshot ID", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "intervaltype", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, { "description": "id of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, + {}, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, - {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { "description": "ID of the disk volume", @@ -24740,24 +25362,19 @@ "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the type of the snapshot", + "name": "snapshottype", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", @@ -24765,64 +25382,116 @@ "type": "state" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, + {}, { "description": "the domain ID of the snapshot's account", "name": "domainid", "type": "string" }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - {}, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "name of the snapshot", + "name": "name", "type": "string" } ] @@ -24833,12 +25502,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,45 +25517,40 @@ "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": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "State of vpn connection", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name", + "name": "project", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "if DPD is enabled for customer gateway", @@ -24895,49 +25558,39 @@ "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", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, - {}, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -24946,54 +25599,70 @@ "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the project name", - "name": "project", + "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 the customer gateway", - "name": "ipsecpsk", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" } ] }, @@ -25003,102 +25672,102 @@ "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", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Kubernetes cluster", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "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": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "state of the Kubernetes cluster", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "page", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "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" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { "description": "Minimum size of the cluster", @@ -25106,24 +25775,25 @@ "type": "long" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the name of the Kubernetes cluster", + "name": "name", + "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 name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { "description": "Public IP Address ID of the cluster", @@ -25131,28 +25801,28 @@ "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { @@ -25161,49 +25831,48 @@ "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "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", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "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", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { @@ -25211,14 +25880,10 @@ "name": "description", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -25227,40 +25892,44 @@ "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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 cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "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" } ] }, @@ -25269,13 +25938,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, @@ -25291,6 +25953,13 @@ "required": false, "type": "uuid" }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the project associated with keypair", "length": 255, @@ -25301,6 +25970,12 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -25311,12 +25986,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", @@ -25330,6 +25999,14 @@ "isasync": true, "name": "createAutoScaleVmGroup", "params": [ + { + "description": "an optional field, whether to the display the group to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "list of scaledown autoscale policies", "length": 255, @@ -25339,43 +26016,35 @@ "type": "list" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "the frequency at which the conditions have to be evaluated", + "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": "interval", - "required": false, + "name": "minmembers", + "required": true, "type": "integer" }, { - "description": "list of scaleup autoscale policies", + "description": "the frequency at which the conditions have to be evaluated", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "interval", + "required": false, + "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": true, "type": "uuid" }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" - }, { "description": "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, @@ -25384,51 +26053,40 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" } ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the project name of the vm profile", - "name": "project", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the 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": "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 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 minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "list of scaledown autoscale policies", @@ -25436,28 +26094,38 @@ "type": "list" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "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 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" }, { @@ -25466,20 +26134,21 @@ "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, + {}, {} ] }, @@ -25488,6 +26157,13 @@ "isasync": false, "name": "searchLdap", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "query to search using", "length": 255, @@ -25496,43 +26172,32 @@ "required": true, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -25541,104 +26206,84 @@ "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, {}, { - "description": "The user's domain", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's principle", + "name": "principal", "type": "string" }, - {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's username", - "name": "username", + "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", + "name": "username", + "type": "string" + } + ], "since": "4.2.0" }, { - "description": "Deletes a load balancer rule.", + "description": "add a baremetal ping pxe server", "isasync": true, - "name": "deleteLoadBalancerRule", + "name": "addBaremetalPxePingServer", "params": [ { - "description": "the ID of the load balancer rule", + "description": "PING storage server ip", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "pingstorageserverip", "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "add a baremetal ping pxe server", - "isasync": true, - "name": "addBaremetalPxePingServer", - "params": [ - { - "description": "URL of the external pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "the Physical Network ID", "length": 255, - "name": "tftpdir", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "PING storage server ip", + "description": "type of pxe device", "length": 255, - "name": "pingstorageserverip", + "name": "pxeservertype", "required": true, "type": "string" }, { - "description": "type of pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "pxeservertype", + "name": "tftpdir", "required": true, "type": "string" }, @@ -25650,33 +26295,25 @@ "type": "string" }, { - "description": "Pod Id", + "description": "Password of PING storage server", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pingcifspassword", "required": false, - "type": "uuid" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Pod Id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "Password of PING storage server", + "description": "URL of the external pxe device", "length": 255, - "name": "pingcifspassword", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -25685,30 +26322,29 @@ "name": "pingdir", "required": true, "type": "string" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "url", + "name": "url", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "PING storage server ip", + "name": "pingstorageserverip", "type": "string" }, { @@ -25716,20 +26352,15 @@ "name": "provider", "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", "type": "string" }, - {}, { - "description": "url", - "name": "url", + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -25738,11 +26369,49 @@ "type": "string" }, { - "description": "device id of ", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" + } + ] + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -25757,13 +26426,6 @@ "required": false, "type": "integer" }, - { - "description": "Id of a Region", - "length": 255, - "name": "regionid", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -25785,15 +26447,25 @@ "related": "createPortableIpRange,listPortableIpRanges", "required": false, "type": "uuid" + }, + { + "description": "Id of a Region", + "length": 255, + "name": "regionid", + "required": false, + "type": "integer" } ], "related": "createPortableIpRange", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { @@ -25801,6 +26473,22 @@ "name": "gateway", "type": "string" }, + {}, + { + "description": "portable IP range ID", + "name": "id", + "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", + "type": "string" + }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", @@ -25811,18 +26499,18 @@ "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -25831,13 +26519,13 @@ "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { @@ -25846,31 +26534,26 @@ "type": "integer" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "public IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" } ], "type": "list" }, { - "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -25878,21 +26561,7 @@ "name": "regionid", "type": "integer" }, - { - "description": "portable IP range ID", - "name": "id", - "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" - } + {} ] }, { @@ -25911,20 +26580,78 @@ ], "related": "", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Base 64 encoded VM user data", + "name": "userdata", + "type": "string" + }, { "description": "the ID of the virtual machine", "name": "virtualmachineid", "type": "string" }, + {}, + {}, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "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 projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -25932,9 +26659,14 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], - "since": "4.4" + "since": "4.17.0" }, { "description": "Lists all configurations.", @@ -25942,18 +26674,20 @@ "name": "listConfigurations", "params": [ { - "description": "lists configuration by name", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "pagesize", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "lists configurations by category", @@ -25963,20 +26697,19 @@ "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the Cluster to update the parameter value for corresponding cluster", @@ -25987,40 +26720,39 @@ "type": "uuid" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "lists configuration by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "List by keyword", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -26028,51 +26760,51 @@ "related": "updateConfiguration", "response": [ { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the name of the configuration", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { "description": "the value of the configuration", "name": "id", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the configuration", + "name": "description", "type": "string" }, - {}, { - "description": "the category of the configuration", - "name": "category", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { "description": "the value of the configuration", "name": "value", "type": "string" - }, - {}, - { - "description": "the name of the configuration", - "name": "name", - "type": "string" } ] }, @@ -26097,21 +26829,21 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -26120,13 +26852,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,51 +26859,58 @@ "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the ID of the network", - "name": "networkid", + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the secondary private IP addr", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the ID of the network", + "name": "networkid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" - }, { "description": "Secondary IP address", "name": "ipaddress", "type": "string" }, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "nicid", + "type": "string" }, + {}, { "description": "the ID of the vm", "name": "virtualmachineid", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -26187,14 +26919,6 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ - { - "description": "the IDs of the nodes to be removed", - "length": 255, - "name": "nodeids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "Minimum number of worker nodes in the cluster", "length": 255, @@ -26203,89 +26927,87 @@ "type": "long" }, { - "description": "number of Kubernetes cluster nodes", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "Maximum number of worker nodes in the cluster", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "maxsize", + "name": "autoscalingenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Maximum number of worker nodes in the cluster", + "length": 255, + "name": "maxsize", "required": false, "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "nodeids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "autoscalingenabled", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, "type": "uuid" } ], "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "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", - "type": "string" - }, - { - "description": "keypair details", - "name": "keypair", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the size (worker nodes count) of the Kubernetes cluster", @@ -26293,79 +27015,85 @@ "type": "long" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "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 service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, - {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, + {}, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { @@ -26374,49 +27102,53 @@ "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, - {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" } ] @@ -26426,6 +27158,13 @@ "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, @@ -26433,442 +27172,440 @@ "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, - "type": "boolean" } ], "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the id of the router", + "name": "id", "type": "string" }, + {}, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "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", + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "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 version of scripts", - "name": "scriptsversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, + {}, { "description": "the gateway for the router", "name": "gateway", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { "description": "the first IPv6 DNS for the router", "name": "ip6dns1", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the Zone ID for the router", + "name": "zoneid", "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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 name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the host ID for the router", + "name": "hostid", "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 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", + "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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" } ] }, @@ -26888,27 +27625,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" + } ] }, { @@ -26916,18 +27653,11 @@ "isasync": false, "name": "deleteHost", "params": [ - { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", - "length": 255, - "name": "forcedestroylocalstorage", - "required": false, - "type": "boolean" - }, { "description": "the 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" }, @@ -26937,26 +27667,33 @@ "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "length": 255, + "name": "forcedestroylocalstorage", + "required": false, + "type": "boolean" } ], "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": "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", @@ -26984,7 +27721,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", "name": "jobid", @@ -26995,11 +27736,7 @@ "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, {} ] }, @@ -27026,25 +27763,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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.16.0.0" @@ -27057,34 +27794,29 @@ "related": "", "response": [ { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" - }, - { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", "type": "boolean" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", - "type": "string" + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", + "type": "boolean" }, { "description": "true if user and domain admins can set templates to be shared, false otherwise", @@ -27092,30 +27824,35 @@ "type": "boolean" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, - {}, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" + "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": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", + "type": "boolean" + }, + { + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "type": "boolean" }, { "description": "true if snapshot is supported for KVM host, false otherwise", @@ -27123,40 +27860,40 @@ "type": "boolean" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", "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": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", + "type": "string" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -27164,8 +27901,8 @@ "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" } ] @@ -27190,23 +27927,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" + } ] }, { @@ -27215,23 +27952,16 @@ "name": "updateTrafficType", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "vmwarenetworklabel", + "name": "ovm3networklabel", "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 XenServer host", "length": 255, - "name": "ovm3networklabel", + "name": "xennetworklabel", "required": false, "type": "string" }, @@ -27244,9 +27974,9 @@ "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "xennetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, @@ -27256,24 +27986,25 @@ "name": "kvmnetworklabel", "required": false, "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "length": 255, + "name": "hypervnetworklabel", + "required": false, + "type": "string" } ], "related": "addTrafficType", "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 KVM host", + "name": "kvmnetworklabel", "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", + "description": "id of the network provider", + "name": "id", "type": "string" }, { @@ -27282,8 +28013,18 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { @@ -27292,8 +28033,8 @@ "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, {}, @@ -27303,15 +28044,11 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "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" }, @@ -27321,19 +28058,11 @@ "name": "listConditions", "params": [ { - "description": "ID of the Condition.", - "length": 255, - "name": "id", - "related": "createCondition,listConditions", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -27344,19 +28073,18 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the policy", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "Counter-id of the condition.", @@ -27367,61 +28095,60 @@ "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the ID of the policy", "length": 255, - "name": "pagesize", + "name": "policyid", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "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": "If set to false, list only 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 the Condition.", + "length": 255, + "name": "id", + "related": "createCondition,listConditions", + "required": false, + "type": "uuid" } ], "related": "createCondition", "response": [ - { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" - }, - { - "description": "the owner of the Condition.", - "name": "account", - "type": "string" - }, - {}, { "description": "the domain id of the Condition owner", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, + {}, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "zone id of counter", + "name": "zoneid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -27429,8 +28156,8 @@ "type": "integer" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -27444,21 +28171,31 @@ "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, + {}, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the id of the Condition", + "name": "id", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -27473,6 +28210,13 @@ "required": false, "type": "list" }, + { + "description": "Enabled/Disabled/Shutdown the physical network service provider", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "network service provider id", "length": 255, @@ -27480,80 +28224,302 @@ "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": true, "type": "uuid" - }, - { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, - "type": "string" } ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ + {}, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + {}, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, { "description": "state of the network provider", "name": "state", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Management Server metrics", + "isasync": false, + "name": "listManagementServersMetrics", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "include system level stats", + "length": 255, + "name": "system", + "related": "listManagementServersMetrics", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" + }, + { + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" + }, + { + "description": "the current cpu load", + "name": "cpuload", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" + }, + { + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" + }, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "uuid of the network provider", + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" + }, + { + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, + { + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" + }, + { + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" + }, + { + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" + }, + { + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" + }, + { + "description": "Amount of memory used", + "name": "systemmemoryused", + "type": "string" + }, + { + "description": "the ID of the management server", "name": "id", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" + }, + { + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" + }, + { + "description": "the name of the management server", + "name": "name", + "type": "string" }, {}, + { + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Free system memory", + "name": "systemmemoryfree", + "type": "string" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" + }, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, + { + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" } ], - "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, @@ -27562,6 +28528,14 @@ "since": "4.4", "type": "map" }, + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, { "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, @@ -27577,22 +28551,22 @@ "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "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" } ] }, @@ -27602,10 +28576,10 @@ "name": "listInstanceGroups", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "list instance groups by ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, @@ -27617,19 +28591,27 @@ "type": "string" }, { - "description": "list instance groups by ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "", @@ -27646,20 +28628,12 @@ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, "name": "listall", "required": false, "type": "boolean" }, - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, { "description": "list instance groups by name", "length": 255, @@ -27668,29 +28642,39 @@ "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the project name of the instance group", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" + }, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the instance group", + "name": "project", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -27703,36 +28687,26 @@ "type": "string" }, {}, - { - "description": "the name of the instance group", - "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 account owning the instance group", "name": "account", "type": "string" }, - { - "description": "the domain ID of the instance group", - "name": "domainid", - "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" + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" } ] }, @@ -27741,14 +28715,6 @@ "isasync": true, "name": "migrateSecondaryStorageData", "params": [ - { - "description": "id of the image store from where the data is to be migrated", - "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - }, { "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", "length": 255, @@ -27763,15 +28729,19 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "list" + }, + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "Response message from migration of secondary storage data objects", - "name": "message", - "type": "string" - }, + {}, { "description": "Type of migration requested for", "name": "migrationtype", @@ -27787,7 +28757,11 @@ "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", @@ -27803,55 +28777,36 @@ "name": "createStaticRoute", "params": [ { - "description": "static route cidr", + "description": "the gateway id we are creating static route for", "length": 255, - "name": "cidr", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the gateway id we are creating static route for", + "description": "static route cidr", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway", + "name": "cidr", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listStaticRoutes", "response": [ - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -27859,14 +28814,19 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -27874,53 +28834,58 @@ "name": "account", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the state of the static route", - "name": "state", + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of static route", + "name": "id", "type": "string" }, - {}, { "description": "VPC the static route belongs to", "name": "vpcid", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { @@ -27928,15 +28893,24 @@ "name": "cidr", "type": "string" }, - {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the state of the static route", + "name": "state", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -27958,12 +28932,12 @@ "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", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { "description": "the name of the ISO attached to the virtual machine", @@ -27971,70 +28945,18 @@ "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "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": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -28042,31 +28964,36 @@ "name": "quiescevm", "type": "boolean" }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, { "description": "pod id of the volume", "name": "podid", "type": "string" }, - {}, { - "description": "the status of the volume", - "name": "status", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + {}, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { "description": "cluster name where the volume is allocated", @@ -28074,14 +29001,14 @@ "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { "description": "name of the availability zone", @@ -28089,99 +29016,89 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of 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": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "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": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "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 volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "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 date the disk volume was created", - "name": "created", - "type": "date" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { "description": "the project id of the vpn", @@ -28189,9 +29106,14 @@ "type": "string" }, { - "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": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { "description": "the boolean state of whether the volume is destroyed or not", @@ -28199,23 +29121,18 @@ "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -28224,79 +29141,137 @@ "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "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": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "the display text of the service offering for root disk", @@ -28304,50 +29279,54 @@ "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": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "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 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": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "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", + "type": "string" } ], "since": "4.14.0" @@ -28357,13 +29336,6 @@ "isasync": true, "name": "addTrafficType", "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": "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, @@ -28372,40 +29344,40 @@ "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "traffictype", - "required": true, + "name": "hypervnetworklabel", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "vlan", + "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 XenServer host", "length": 255, - "name": "ovm3networklabel", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "vlan", + "name": "ovm3networklabel", "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", @@ -28420,6 +29392,13 @@ "name": "kvmnetworklabel", "required": false, "type": "string" + }, + { + "description": "the trafficType to be added to the physical network", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" } ], "related": "", @@ -28430,52 +29409,52 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, - {}, { "description": "id of the network provider", "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", - "type": "string" + "description": "the current status of the latest 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 network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -28488,14 +29467,23 @@ "description": "the ID of the private gateway", "length": 255, "name": "id", - "related": "createPrivateGateway", + "related": "createPrivateGateway,createPrivateGateway", "required": true, "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -28506,16 +29494,7 @@ "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" - } + {} ] }, { @@ -28526,21 +29505,21 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "", "length": 255, - "name": "applied", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "lbvmips", + "name": "applied", "required": false, "type": "boolean" }, @@ -28551,45 +29530,45 @@ "required": false, "type": "string" }, + { + "description": "true if load balancer rule VM IP information to be included; default is false", + "length": 255, + "name": "lbvmips", + "required": false, + "type": "boolean" + }, { "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "listLoadBalancerRuleInstances", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "IP addresses of the vm set of lb rule", "name": "lbvmipaddresses", "type": "list" }, - { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" - }, {}, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" } ] }, @@ -28614,22 +29593,22 @@ "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" - } + }, + {} ] }, { @@ -28644,13 +29623,6 @@ "required": false, "type": "string" }, - { - "description": "updates domain with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "ID of domain to update", "length": 255, @@ -28658,33 +29630,36 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, "type": "uuid" + }, + { + "description": "updates domain with this name", + "length": 255, + "name": "name", + "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 secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { @@ -28693,69 +29668,54 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "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", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "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 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 domain", - "name": "templateavailable", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { "description": "the total number of networks owned by domain", @@ -28763,8 +29723,13 @@ "type": "long" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { @@ -28773,75 +29738,98 @@ "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, - {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, - {}, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, { "description": "the path of the domain", "name": "path", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { @@ -28850,34 +29838,35 @@ "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the ID of the domain", + "name": "id", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "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 number of vpcs available to be created for this domain", @@ -28885,24 +29874,19 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { "description": "the total number of networks the domain can own", @@ -28910,14 +29894,9 @@ "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" } ] }, @@ -28927,16 +29906,16 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "the VLAN for the physical network", + "description": "Tag the physical network", "length": 255, - "name": "vlan", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "the VLAN for the physical network", "length": 255, - "name": "networkspeed", + "name": "vlan", "required": false, "type": "string" }, @@ -28949,16 +29928,16 @@ "type": "uuid" }, { - "description": "Tag the physical network", + "description": "Enabled/Disabled", "length": 255, - "name": "tags", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "Enabled/Disabled", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "state", + "name": "networkspeed", "required": false, "type": "string" } @@ -28966,70 +29945,70 @@ "related": "createPhysicalNetwork", "response": [ { - "description": "zone name of the physical network", - "name": "zonename", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, {}, { - "description": "name of the physical network", - "name": "name", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "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", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma separated tag", - "name": "tags", + "description": "state of the physical network", + "name": "state", "type": "string" }, + {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "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", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "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": "zone id of the physical network", + "name": "zoneid", + "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the uuid of the physical network", + "name": "id", "type": "string" } ], @@ -29052,40 +30031,55 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the project name of the vm profile", - "name": "project", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, + { + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, { "description": "is group for display to the regular user", "name": "fordisplay", "type": "boolean" }, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the 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 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", + "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 account owning the instance group", - "name": "account", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the frequency at which the conditions have to be evaluated", @@ -29093,24 +30087,23 @@ "type": "int" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the domain ID of the vm profile", + "name": "domainid", + "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { @@ -29119,25 +30112,11 @@ "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 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" - } + {} ] }, { @@ -29154,7 +30133,14 @@ "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, "name": "intervaltype", "required": true, @@ -29168,18 +30154,19 @@ "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)", + "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": "tags", - "required": false, - "type": "map" + "name": "schedule", + "required": true, + "type": "string" }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", @@ -29187,126 +30174,118 @@ "name": "timezone", "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", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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 project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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" } ], "type": "set" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" }, {}, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + {}, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -29330,23 +30309,23 @@ "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,14 +30334,6 @@ "isasync": false, "name": "createRolePermission", "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - }, { "description": "The description of the role permission", "length": 255, @@ -29370,6 +30341,13 @@ "required": false, "type": "string" }, + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, { "description": "The rule permission, allow or deny. Default: deny.", "length": 255, @@ -29378,29 +30356,24 @@ "type": "string" }, { - "description": "The API name or wildcard rule such as list*", + "description": "ID of the role", "length": 255, - "name": "rule", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listRolePermissions", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { @@ -29409,8 +30382,18 @@ "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 ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { @@ -29419,16 +30402,12 @@ "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - } + {} ], "since": "4.9.0" }, @@ -29438,36 +30417,34 @@ "name": "listSystemVms", "params": [ { - "description": "the storage ID where vm's volumes belong to", + "description": "the ID of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "since": "3.0.1", "type": "uuid" }, { - "description": "the Pod ID of the system VM", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the system VM", + "description": "the name of the system VM", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "", @@ -29477,46 +30454,48 @@ "type": "integer" }, { - "description": "", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "uuid" }, { - "description": "List by keyword", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "keyword", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the state of the system VM", "length": 255, - "name": "systemvmtype", + "name": "state", "required": false, "type": "string" }, { - "description": "the Zone ID of the system VM", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the system VM", + "description": "the Zone ID of the system VM", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the host ID of the system VM", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" } @@ -29524,54 +30503,53 @@ "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", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -29580,39 +30558,38 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { @@ -29621,103 +30598,105 @@ "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Pod name for the system VM", + "name": "podname", "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", - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the ID of the system VM", - "name": "id", + "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": "guest vlan range", + "name": "guestvlan", "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": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, + {}, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "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 template name for the system VM", - "name": "templatename", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "guest 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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" } ] @@ -29728,28 +30707,27 @@ "name": "createProject", "params": [ { - "description": "account who will be Admin for the project", + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", "length": 255, - "name": "account", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "string" + "since": "4.15.0", + "type": "uuid" }, { - "description": "domain ID of the account owning a project", + "description": "account who will be Admin for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "description": "name of the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "since": "4.15.0", - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "display text of the project", @@ -29767,29 +30745,30 @@ "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 primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { "description": "the state of the project", @@ -29797,86 +30776,24 @@ "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "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": "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { "description": "the total number of networks the project can own", @@ -29884,23 +30801,18 @@ "type": "string" }, { - "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 displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -29909,166 +30821,233 @@ "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", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, + {}, { "description": "the total primary storage space (in GiB) available to be used for this project", "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "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", + "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", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "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", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { - "description": "the name of the project", - "name": "name", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" } ], "since": "3.0.0" @@ -30082,7 +31061,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -30096,17 +31075,18 @@ } ], "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -30116,8 +31096,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -30126,11 +31105,12 @@ "name": "addCiscoVnmcResource", "params": [ { - "description": "Hostname or ip address of the Cisco VNMC Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "hostname", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to access the Cisco VNMC Controller API", @@ -30140,40 +31120,39 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "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" } ], "related": "listCiscoVnmcResources", "response": [ - {}, - {}, - {}, - {}, - {}, - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ] }, { @@ -30185,7 +31164,7 @@ "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" }, @@ -30205,56 +31184,42 @@ "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": "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", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the project id of the vpn", + "name": "projectid", "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 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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -30263,143 +31228,73 @@ "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "state of the virtual machine", + "name": "vmstate", "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": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -30412,8 +31307,13 @@ "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", "type": "string" }, { @@ -30427,13 +31327,13 @@ "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" }, { @@ -30442,13 +31342,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -30460,43 +31355,94 @@ "type": "set" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, { "description": "size of the disk volume", "name": "size", "type": "long" }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -30504,91 +31450,129 @@ "name": "storageid", "type": "string" }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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 storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the write (io) of disk on the vm", + "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, { "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" } ] @@ -30598,6 +31582,14 @@ "isasync": true, "name": "replaceNetworkACLList", "params": [ + { + "description": "the ID of the private gateway", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": false, + "type": "uuid" + }, { "description": "the ID of the network ACL", "length": 255, @@ -30610,42 +31602,34 @@ "description": "the ID of the network", "length": 255, "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the private gateway", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -30653,14 +31637,6 @@ "isasync": true, "name": "markDefaultZoneForAccount", "params": [ - { - "description": "Name of the account that is to be marked.", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": true, - "type": "string" - }, { "description": "The Zone ID with which the account is to be marked.", "length": 255, @@ -30669,6 +31645,14 @@ "required": true, "type": "uuid" }, + { + "description": "Name of the account that is to be marked.", + "length": 255, + "name": "account", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": true, + "type": "string" + }, { "description": "Marks the account that belongs to the specified domain.", "length": 255, @@ -30681,50 +31665,49 @@ "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, - {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the Domain the account belongs to", + "name": "domain", "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 total number of public ip addresses available for this account to acquire", @@ -30732,18 +31715,18 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -30752,79 +31735,54 @@ "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "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 owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -30833,127 +31791,127 @@ "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total number of 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", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the ID of the role", - "name": "roleid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of the role", + "name": "rolename", "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 account type of the user", - "name": "accounttype", - "type": "short" - }, { "description": "the user name", "name": "username", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "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 type of the role", - "name": "roletype", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -30962,142 +31920,168 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" } ], "type": "list" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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 network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + {}, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "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 vpcs the account can own", - "name": "vpclimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "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" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" } ], "since": "4.0" @@ -31119,62 +32103,51 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ { - "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 powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - {}, { - "description": "the out-of-band management interface address", - "name": "address", + "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 powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "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", + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, + {}, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -31184,6 +32157,17 @@ "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": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" } ], "since": "4.9.0" @@ -31194,99 +32178,99 @@ "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", + "description": "List by keyword", "length": 255, - "name": "listtype", + "name": "keyword", "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", + "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": "userfilter", + "name": "listtype", "required": false, - "since": "4.13", "type": "string" }, { - "description": "linked domain", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", "length": 255, - "name": "page", + "name": "userfilter", "required": false, - "type": "integer" + "since": "4.13", + "type": "string" }, { - "description": "", + "description": "linked domain", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, + {}, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", "name": "conflictingusersource", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's domain", + "name": "domain", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's principle", + "name": "principal", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's email", + "name": "email", + "type": "string" + } ], "since": "4.2.0" }, @@ -31295,13 +32279,6 @@ "isasync": true, "name": "revokeCertificate", "params": [ - { - "description": "The certificate serial number, as a hex value", - "length": 255, - "name": "serial", - "required": true, - "type": "string" - }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -31315,13 +32292,20 @@ "name": "cn", "required": false, "type": "string" + }, + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, + "type": "string" } ], "response": [ { - "description": "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", @@ -31329,17 +32313,17 @@ "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.11.0" }, @@ -31356,6 +32340,13 @@ "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": "The ID of the system vm", "length": 255, @@ -31363,55 +32354,53 @@ "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", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "guest vlan range", + "name": "guestvlan", "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "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" }, { @@ -31419,10 +32408,11 @@ "name": "templatename", "type": "string" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { "description": "the second DNS for the system VM", @@ -31435,89 +32425,73 @@ "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the system VM", + "name": "name", "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 Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the ID of the system VM", + "name": "id", "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -31526,29 +32500,29 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the gateway for the system VM", + "name": "gateway", "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 first DNS for the system VM", - "name": "dns1", - "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": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -31557,18 +32531,28 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "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 public netmask for the system VM", + "name": "publicnetmask", "type": "string" } ] @@ -31579,9 +32563,9 @@ "name": "updateSiocInfo", "params": [ { - "description": "Notify if IOPS above this value", + "description": "Shares per GB", "length": 255, - "name": "iopsnotifythreshold", + "name": "sharespergb", "required": true, "type": "integer" }, @@ -31602,38 +32586,38 @@ "type": "uuid" }, { - "description": "Limit IOPS per GB", + "description": "Notify if IOPS above this value", "length": 255, - "name": "limitiopspergb", + "name": "iopsnotifythreshold", "required": true, "type": "integer" }, { - "description": "Shares per GB", + "description": "Limit IOPS per GB", "length": 255, - "name": "sharespergb", + "name": "limitiopspergb", "required": true, "type": "integer" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, {} ], "since": "4.11.0" @@ -31644,57 +32628,57 @@ "name": "listIpForwardingRules", "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", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "list the rule belonging to this public IP address", "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": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list the rule belonging to this public IP address", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "page", "required": false, - "type": "uuid" + "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,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "listall", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -31704,18 +32688,18 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -31726,28 +32710,37 @@ "type": "uuid" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, { "description": "the VM name for the port forwarding rule", "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the 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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { "description": "the VM ID for the port forwarding rule", @@ -31755,8 +32748,8 @@ "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -31764,20 +32757,16 @@ "name": "ipaddress", "type": "string" }, + {}, + {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -31790,43 +32779,23 @@ "name": "jobid", "type": "string" }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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", + "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" }, { @@ -31835,47 +32804,62 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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 id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -31884,14 +32868,35 @@ "isasync": true, "name": "createSnapshot", "params": [ + { + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" + }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,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": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", + "required": false, + "type": "boolean" + }, { "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, @@ -31906,20 +32911,6 @@ "required": false, "type": "string" }, - { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" - }, - { - "description": "asynchronous backup if true", - "length": 255, - "name": "asyncbackup", - "required": false, - "type": "boolean" - }, { "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, @@ -31942,37 +32933,116 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" } ], "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ + { + "description": "the account associated with the snapshot", + "name": "account", + "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": "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, { "description": "id of the availability zone", "name": "zoneid", "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": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "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 type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the list of resource tags associated", "name": "tags", @@ -31988,13 +33058,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -32003,8 +33073,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -32013,123 +33083,37 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "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": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, { "description": "the project name of the snapshot", "name": "project", "type": "string" }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, {}, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" } ] @@ -32150,27 +33134,27 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.2.0" }, @@ -32180,47 +33164,48 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Zone ID for the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the Pod ID for the storage pool", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IP address for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "ipaddress", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the storage pool path", "length": 255, - "name": "keyword", + "name": "path", "required": false, "type": "string" }, { - "description": "the storage pool path", + "description": "the ID of the storage pool", "length": 255, - "name": "path", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -32232,27 +33217,26 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "List by keyword", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the IP address for the storage pool", "length": 255, - "name": "pagesize", + "name": "ipaddress", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -32265,14 +33249,14 @@ "related": "", "response": [ { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "the name of the storage pool", @@ -32280,84 +33264,94 @@ "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" + "description": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + {}, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the scope of the storage pool", + "name": "scope", "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": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { @@ -32366,84 +33360,74 @@ "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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": "Storage provider for this pool", + "name": "provider", + "type": "string" }, - {}, { "description": "the storage pool path", "name": "path", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", - "type": "string" + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool type", + "name": "type", "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 Pod name of the storage pool", + "name": "podname", "type": "string" } ], @@ -32465,11 +33449,7 @@ ], "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", @@ -32481,7 +33461,11 @@ "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "details of the unmanage VM operation", "name": "details", @@ -32514,45 +33498,117 @@ ], "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + { + "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 gateway for the router", + "name": "gateway", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -32560,167 +33616,195 @@ "name": "projectid", "type": "string" }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, { "description": "the link local MAC address for the router", "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, { "description": "the public netmask for the router", "name": "publicnetmask", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "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 template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "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 broadcast uri of the nic", + "name": "broadcasturi", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { "description": "Type of adapter if available", @@ -32728,23 +33812,18 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -32753,38 +33832,38 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, { "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -32793,33 +33872,28 @@ "type": "boolean" }, { - "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 netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -32827,32 +33901,22 @@ "name": "networkname", "type": "string" }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" } ], "type": "set" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -32861,84 +33925,9 @@ "type": "date" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "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 second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the id of the router", + "name": "id", "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" } ] }, @@ -32947,27 +33936,20 @@ "isasync": false, "name": "listNics", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list nic of the specific vm's 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" }, { - "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", @@ -32978,11 +33960,18 @@ "type": "boolean" }, { - "description": "the ID of the vm", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the nic to to list IPs", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": false, "type": "uuid" }, { @@ -32993,31 +33982,40 @@ "type": "integer" }, { - "description": "the ID of the nic to to list IPs", + "description": "the ID of the vm", "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the Secondary ipv4 addr of nic", @@ -33025,13 +34023,13 @@ "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -33040,84 +34038,65 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the 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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, - {}, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", "type": "string" }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "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 ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -33126,23 +34105,33 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, { "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" } ] @@ -33153,18 +34142,12 @@ "name": "createSSHKeyPair", "params": [ { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", + "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 +34158,30 @@ "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "Name of the keypair", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Private key", - "name": "privatekey", + "name": "name", + "required": true, "type": "string" }, { - "description": "the owner of the keypair", + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { @@ -33211,19 +34190,19 @@ "type": "boolean" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, + {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Name of the keypair", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -33231,53 +34210,23 @@ "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", + "description": "Private key", + "name": "privatekey", "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 owner of the keypair", + "name": "account", + "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Creates an instant snapshot of a volume from existing vm snapshot.", @@ -33288,17 +34237,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 +34248,25 @@ "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" - } - ], - "related": "archiveSnapshot,revertSnapshot", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "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": "name of the snapshot", + "description": "the name of the snapshot", + "length": 255, "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "archiveSnapshot,revertSnapshot", + "response": [ { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -33366,13 +34275,8 @@ "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -33380,13 +34284,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -33395,99 +34304,139 @@ "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", - "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", + "description": "resource type", + "name": "resourcetype", "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": "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" } ], "type": "set" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "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": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", "type": "string" }, + { + "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { "description": "the project id of the snapshot", "name": "projectid", "type": "string" }, - {}, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" } ], "since": "4.10.0" @@ -33498,38 +34447,37 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "an optional project of the security group", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "user to security group mapping", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "usersecuritygrouplist", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "start port for this egress rule", + "description": "user to security group mapping", "length": 255, - "name": "startport", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "account", + "name": "securitygroupname", "required": false, "type": "string" }, @@ -33542,23 +34490,24 @@ "type": "uuid" }, { - "description": "TCP is default. UDP is the other supported protocol", + "description": "an optional project of the security group", "length": 255, - "name": "protocol", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "error code for this icmp message", + "description": "end port for this egress rule", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, { - "description": "end port for this egress rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" }, @@ -33571,51 +34520,76 @@ "type": "uuid" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "start port for this egress rule", "length": 255, - "name": "cidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "type of the icmp message being sent", "length": 255, - "name": "securitygroupname", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" } ], "related": "authorizeSecurityGroupIngress", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, - {}, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + {}, + {}, { "description": "the 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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -33624,13 +34598,8 @@ "type": "string" }, { - "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" }, { @@ -33644,13 +34613,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -33659,8 +34628,13 @@ "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" } ], @@ -33672,33 +34646,8 @@ "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" - }, - { - "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ], @@ -33710,40 +34659,33 @@ "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 name of the storage pool", "length": 255, - "name": "pagesize", + "name": "name", "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" }, { "description": "the ID of the storage pool", "length": 255, - "name": "id", + "name": "scope", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" - }, - { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, "type": "string" }, { @@ -33754,12 +34696,26 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the ID of the storage pool", "length": 255, - "name": "scope", + "name": "id", "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "type": "uuid" + }, + { + "description": "the IP address for the storage pool", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { @@ -33771,11 +34727,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the storage pool path", @@ -33783,41 +34739,34 @@ "name": "path", "required": false, "type": "string" - }, - { - "description": "the name of the storage pool", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "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", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -33825,116 +34774,116 @@ "name": "zonename", "type": "string" }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the ID of the storage pool", - "name": "id", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "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 IP address of the storage pool", + "name": "ipaddress", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, { "description": "the ID of the cluster for the storage pool", "name": "clusterid", "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "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", + "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "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 tags for the storage pool", - "name": "tags", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -33943,13 +34892,6 @@ "isasync": false, "name": "updateHypervisorCapabilities", "params": [ - { - "description": "the max number of Guest VMs per host for this hypervisor.", - "length": 255, - "name": "maxguestslimit", - "required": false, - "type": "long" - }, { "description": "ID of the hypervisor capability", "length": 255, @@ -33967,43 +34909,51 @@ "type": "integer" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "vmsnapshotenabled", + "name": "maxdatavolumeslimit", "required": false, "since": "4.16.0", - "type": "boolean" + "type": "integer" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "securitygroupenabled", + "name": "storagemotionenabled", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "storagemotionenabled", + "name": "vmsnapshotenabled", "required": false, "since": "4.16.0", "type": "boolean" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "maxdatavolumeslimit", + "name": "maxguestslimit", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "long" + }, + { + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" } ], "related": "listHypervisorCapabilities", "response": [ + {}, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the hypervisor type", @@ -34017,18 +34967,13 @@ }, {}, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - }, - { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { @@ -34036,22 +34981,26 @@ "name": "vmsnapshotenabled", "type": "boolean" }, - {}, - { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { "description": "the 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 guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, { "description": "the maximum number of Hosts per cluster for this hypervisor", "name": "maxhostspercluster", @@ -34072,6 +35021,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", "length": 255, @@ -34080,13 +35036,6 @@ "required": true, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -34098,24 +35047,29 @@ "related": "", "response": [ { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "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": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the ID of the host", @@ -34123,216 +35077,199 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "averageload", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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 name of the host", + "name": "name", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, - {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, { "description": "the state of the host", "name": "state", "type": "status" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "averageload", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { "description": "the incoming network traffic on the host", @@ -34340,25 +35277,37 @@ "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, { "description": "the 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 IP address of the host", + "name": "ipaddress", "type": "string" }, { - "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" + }, + {} ] }, { @@ -34378,77 +35327,77 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, - {}, - {}, { "description": "device id of the Cisco N1KV VSM device", "name": "vsmdeviceid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "device state", + "name": "vsmdevicestate", + "type": "string" }, + {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -34464,6 +35413,14 @@ "required": true, "type": "uuid" }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "guest vlan range to be dedicated", "length": 255, @@ -34472,12 +35429,11 @@ "type": "string" }, { - "description": "project who will own the VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "domain ID of the account owning a VLAN", @@ -34486,26 +35442,20 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "listDedicatedGuestVlanRanges", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "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", @@ -34513,27 +35463,15 @@ "type": "long" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, - {}, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - {}, { "description": "the domain name of the guest VLAN range", "name": "domain", @@ -34545,15 +35483,26 @@ "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, { "description": "the project name of the guest vlan range", "name": "project", "type": "string" - } + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + }, + {} ] }, { @@ -34561,13 +35510,6 @@ "isasync": true, "name": "addNicToVirtualMachine", "params": [ - { - "description": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, { "description": "Virtual Machine ID", "length": 255, @@ -34576,25 +35518,32 @@ "required": true, "type": "uuid" }, + { + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptions", + "required": false, + "type": "map" + }, { "description": "Network ID", "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": true, "type": "uuid" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "Mac Address for the new network", "length": 255, - "name": "dhcpoptions", + "name": "macaddress", "required": false, - "type": "map" + "type": "string" }, { - "description": "Mac Address for the new network", + "description": "IP Address for the new network", "length": 255, - "name": "macaddress", + "name": "ipaddress", "required": false, "type": "string" } @@ -34602,225 +35551,47 @@ "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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": " 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", - "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of 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 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", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, { "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -34829,13 +35600,13 @@ "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -34844,13 +35615,18 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "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 name of the affinity group", + "name": "project", "type": "string" }, { @@ -34862,239 +35638,142 @@ "type": "set" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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": "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": "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", + "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", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", @@ -35106,33 +35785,33 @@ "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -35141,13 +35820,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -35159,104 +35838,84 @@ "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", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "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", + "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 CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -35265,13 +35924,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -35283,88 +35942,185 @@ "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -35373,33 +36129,28 @@ "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -35408,95 +36159,105 @@ "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "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", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -35510,193 +36271,366 @@ "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" }, { - "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + {}, + { + "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 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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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": "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": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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": "", - "response": [ + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, { - "description": "the project name of the static route", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, - {}, { - "description": "the state of the static route", - "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": "VPC the static route belongs to", - "name": "vpcid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + } + ] + }, + { + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list static routes by vpc id", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list static routes by gateway id", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list static route by id", + "length": 255, + "name": "id", + "related": "listStaticRoutes", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list static routes by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + {}, + {}, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "the list of resource tags associated with static route", + "name": "tags", + "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -35705,8 +36639,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -35714,6 +36648,16 @@ "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": "id of the resource", "name": "resourceid", @@ -35725,13 +36669,8 @@ "type": "string" }, { - "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" }, { @@ -35742,19 +36681,14 @@ ], "type": "list" }, - { - "description": "VPC gateway the route is created for", - "name": "gatewayid", - "type": "string" - }, { "description": "the project id of the static route", "name": "projectid", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the state of the static route", + "name": "state", "type": "string" }, { @@ -35763,8 +36697,13 @@ "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -35773,8 +36712,18 @@ "type": "integer" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", "type": "string" } ] @@ -35785,24 +36734,24 @@ "name": "listPublicIpAddresses", "params": [ { - "description": "List IPs belonging to the VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "isrecursive", + "name": "allocatedonly", "required": false, "type": "boolean" }, @@ -35815,31 +36764,32 @@ "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the virtual network for the IP address", + "description": "list only static NAT IP addresses", "length": 255, - "name": "forvirtualnetwork", + "name": "isstaticnat", "required": false, "type": "boolean" }, { - "description": "list only IPs used for load balancing", + "description": "", "length": 255, - "name": "forloadbalancing", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, @@ -35851,93 +36801,91 @@ "type": "string" }, { - "description": "lists all public IP addresses by source network ID", + "description": "lists all public IP addresses by zone ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.13.0", "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "tags", + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list only static NAT IP addresses", + "description": "", "length": 255, - "name": "isstaticnat", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "lists IP address by ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "the virtual network for the IP address", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list only source NAT IP addresses", "length": 255, - "name": "keyword", + "name": "issourcenat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list only source NAT IP addresses", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "issourcenat", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.13.0", "type": "uuid" }, { - "description": "limits search results to allocated public IP addresses", + "description": "list only IPs used for load balancing", "length": 255, - "name": "allocatedonly", + "name": "forloadbalancing", "required": false, "type": "boolean" }, @@ -35949,17 +36897,18 @@ "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 IPs belonging to the VPC", "length": 255, - "name": "listall", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists all public IP addresses by zone ID", + "description": "lists IP address by ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" } @@ -35967,18 +36916,13 @@ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -35987,13 +36931,8 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { @@ -36001,56 +36940,97 @@ "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", + "description": "public IP address id", + "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 this belongs to", - "name": "physicalnetworkid", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { @@ -36059,14 +37039,14 @@ "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { "description": "is public IP portable across the zones", @@ -36074,19 +37054,24 @@ "type": "boolean" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", @@ -36094,33 +37079,8 @@ "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", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -36129,179 +37089,59 @@ "type": "boolean" }, { - "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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "description": "lists F5 load balancer devices", - "isasync": false, - "name": "listF5LoadBalancers", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "f5 load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addF5LoadBalancer,listF5LoadBalancers", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "addF5LoadBalancer", - "response": [ - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "device name", - "name": "lbdevicename", + "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 physical network to which this F5 device belongs to", - "name": "physicalnetworkid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "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", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP address", + "name": "ipaddress", "type": "string" } ] @@ -36312,30 +37152,9 @@ "name": "updateIso", "params": [ { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "true if the image supports the password reset feature; default is false", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "passwordenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, @@ -36356,58 +37175,79 @@ "type": "uuid" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "sshkeyenabled", + "name": "bootable", "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": "the format for the image", "length": 255, - "name": "cleanupdetails", + "name": "format", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "sortkey", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "bootable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the format for the image", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "format", + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" } @@ -36415,49 +37255,49 @@ "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the tag of this template", - "name": "templatetag", - "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 status of the template", - "name": "status", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the OS type for this template.", @@ -36465,79 +37305,94 @@ "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "true if the template is managed across all Zones, false otherwise", "name": "crossZones", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -36546,18 +37401,18 @@ "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 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" }, { @@ -36569,24 +37424,19 @@ "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "description": "the account name to which the template belongs", @@ -36594,13 +37444,8 @@ "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", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -36609,18 +37454,18 @@ "type": "date" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -36628,74 +37473,69 @@ "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", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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 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": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -36704,560 +37544,687 @@ "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" } ] }, { - "description": "Lists F5 external load balancer appliances added in a zone.", + "description": "Lists OpenDyalight controllers", "isasync": false, - "name": "listExternalLoadBalancers", + "name": "listOpenDaylightControllers", "params": [ { - "description": "zone Id", + "description": "the Physical Network ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, - "type": "integer" - }, + "type": "uuid" + } + ], + "related": "addOpenDaylightController,deleteOpenDaylightController", + "response": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" - } - ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "response": [ + }, { - "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "the url of the controller api", + "name": "url", + "type": "string" }, + {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the name assigned to the controller", + "name": "name", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the username to authenticate to the controller", + "name": "username", "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": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ { - "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": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, "type": "string" - }, + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "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": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the controller username", + "name": "username", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the 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", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "NAT support", + "name": "nat", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the controller password", + "name": "password", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes a counter", + "isasync": true, + "name": "deleteCounter", + "params": [ { - "description": "the host version", - "name": "version", + "description": "the ID of the counter", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {} + ] + }, + { + "description": "Changes the default NIC on a VM", + "isasync": true, + "name": "updateDefaultNicForVirtualMachine", + "params": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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 percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "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 hypervisor version", - "name": "hypervisorversion", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "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 disk size of the host", - "name": "disksizetotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - {}, { - "description": "the ID of the host", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - {}, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - } - ] - }, - { - "description": "Lists OpenDyalight controllers", - "isasync": false, - "name": "listOpenDaylightControllers", - "params": [ - { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ - { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the url of the controller api", - "name": "url", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "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 isolation uri of the nic", + "name": "isolationuri", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {} - ] - }, - { - "description": "Adds a BigSwitch BCF Controller device", - "isasync": true, - "name": "addBigSwitchBcfDevice", - "params": [ { - "description": "Password of the BigSwitch BCF Controller.", - "length": 255, - "name": "password", - "required": true, - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", - "length": 255, - "name": "hostname", - "required": true, - "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 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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Username of the BigSwitch BCF Controller.", - "length": 255, + "description": "the user's name who deployed the virtual machine", "name": "username", - "required": true, "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "NAT support of the BigSwitch BCF Controller.", - "length": 255, - "name": "nat", - "required": true, - "type": "boolean" - } - ], - "related": "listBigSwitchBcfDevices", - "response": [ - { - "description": "name of the provider", - "name": "provider", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the controller username", - "name": "username", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -37265,578 +38232,155 @@ "type": "integer" }, { - "description": "the controller password", - "name": "password", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Deletes a counter", - "isasync": true, - "name": "deleteCounter", - "params": [ - { - "description": "the ID of the counter", - "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" - } - ] - }, - { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ - { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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" }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the 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", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - { - "description": "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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 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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "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 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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "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 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": "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 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 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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "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", - "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": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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 project id the tag belongs to", - "name": "projectid", - "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", + "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 ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { "description": "the code for the ICMP message response", @@ -37844,57 +38388,57 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -37907,6 +38451,16 @@ "name": "value", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -37918,102 +38472,169 @@ "type": "string" }, { - "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" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the 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 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": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -38022,28 +38643,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 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": "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": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -38053,8 +38674,8 @@ "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -38063,238 +38684,57 @@ "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", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the domain name of the security group", "name": "domain", "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of 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": "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" - } - ], - "type": "set" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 ID of the affinity group", - "name": "id", - "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 name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the outgoing network traffic on the host", + "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" } ] }, @@ -38323,17 +38763,17 @@ "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" - }, {} ] }, @@ -38343,12 +38783,11 @@ "name": "issueOutOfBandManagementPowerAction", "params": [ { - "description": "the ID of the host", + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "action", "required": true, - "type": "uuid" + "type": "string" }, { "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", @@ -38358,34 +38797,36 @@ "type": "long" }, { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "description": "the ID of the host", "length": 255, - "name": "action", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the host", @@ -38394,24 +38835,23 @@ }, {}, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { @@ -38420,18 +38860,18 @@ "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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -38442,13 +38882,6 @@ "isasync": true, "name": "issueCertificate", "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": "Certificate validity duration in number of days, when not provided the default configured value will be used", "length": 255, @@ -38457,16 +38890,23 @@ "type": "integer" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "Comma separated list of IP addresses, the certificate should be issued for", "length": 255, - "name": "provider", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, + "type": "string" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "ipaddress", + "name": "provider", "required": false, "type": "string" }, @@ -38480,18 +38920,22 @@ ], "related": "listCaCertificate", "response": [ - {}, { "description": "Private key for the certificate", "name": "privatekey", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The client certificate", "name": "certificate", "type": "string" }, - {}, { "description": "The CA certificate(s)", "name": "cacertificates", @@ -38502,11 +38946,7 @@ "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" }, @@ -38519,12 +38959,17 @@ "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + { + "description": "the 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", @@ -38535,18 +38980,13 @@ "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" - }, - {}, - {} + } ] }, { @@ -38572,78 +39012,78 @@ ], "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the url of the image store", + "name": "url", + "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "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 url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - {} + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + } ], "since": "4.15.0" }, @@ -38653,19 +39093,18 @@ "name": "createPortForwardingRule", "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the starting port of port forwarding rule's public port range", "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", + "name": "publicport", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the starting port of port forwarding rule's private port range", + "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": "privateport", - "required": true, - "type": "integer" + "name": "openfirewall", + "required": false, + "type": "boolean" }, { "description": "the IP address id of the port forwarding rule", @@ -38682,14 +39121,6 @@ "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,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, @@ -38697,6 +39128,13 @@ "required": true, "type": "string" }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -38706,49 +39144,55 @@ "type": "boolean" }, { - "description": "VM guest nic secondary IP address for the port forwarding 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": "vmguestip", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "publicport", + "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": "integer" + "type": "uuid" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "cidrlist", + "name": "vmguestip", "required": false, - "type": "list" + "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "the starting port of port forwarding rule's private port range", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "privateport", + "required": true, + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", + "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": "publicendport", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "listPortForwardingRules,updatePortForwardingRule", + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "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", "type": "string" }, - {}, {}, { "description": "the ID of the port forwarding rule", @@ -38756,8 +39200,8 @@ "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -38766,33 +39210,28 @@ "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 state of the rule", - "name": "state", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { @@ -38801,18 +39240,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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 state of the rule", + "name": "state", "type": "string" }, { @@ -38821,18 +39261,18 @@ "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "the 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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -38840,8 +39280,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -38850,8 +39295,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -38860,33 +39305,28 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], @@ -38900,10 +39340,10 @@ "name": "dedicateZone", "params": [ { - "description": "the ID of the zone", + "description": "the ID of the containing domain", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": true, "type": "uuid" }, @@ -38915,34 +39355,45 @@ "type": "string" }, { - "description": "the ID of the containing domain", + "description": "the ID of the zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], "related": "", "response": [ + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the Name of the Zone", "name": "zonename", "type": "string" }, + {}, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "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 Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { @@ -38951,22 +39402,11 @@ "type": "integer" }, {}, - { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" - }, { "description": "the ID of the Zone", "name": "zoneid", "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - {} + } ] }, { @@ -38974,6 +39414,14 @@ "isasync": false, "name": "prepareTemplate", "params": [ + { + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, @@ -38989,119 +39437,116 @@ "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": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "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 tag of this template", - "name": "templatetag", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, - {}, { "description": "true if the template is ready to be deployed from, false otherwise.", "name": "isready", "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the account id to which the template belongs", "name": "accountid", @@ -39117,24 +39562,28 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -39143,132 +39592,107 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "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 name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "additional key/value details tied with template", @@ -39276,33 +39700,49 @@ "type": "map" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, + {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" } ] @@ -39316,7 +39756,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule", + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -39338,28 +39778,28 @@ } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "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" + }, + {} ] }, { @@ -39368,39 +39808,40 @@ "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", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "tzdate" + "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", "required": false, - "type": "boolean" + "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": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "List by keyword", @@ -39410,19 +39851,18 @@ "type": "string" }, { - "description": "", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "tzdate" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "queryAsyncJobResult", @@ -39437,11 +39877,6 @@ "name": "cmd", "type": "string" }, - { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -39452,20 +39887,25 @@ "name": "created", "type": "date" }, - {}, { - "description": "the result type", - "name": "jobresulttype", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, + {}, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", + "description": " the completed date of the job", + "name": "completed", + "type": "date" + }, + { + "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", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { @@ -39474,30 +39914,30 @@ "type": "responseobject" }, { - "description": "the account that executed the async command", - "name": "accountid", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, + {}, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the account that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" } ] }, @@ -39507,19 +39947,18 @@ "name": "archiveAlerts", "params": [ { - "description": "archive by alert type", + "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": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the IDs of the alerts", + "description": "archive by alert type", "length": 255, - "name": "ids", - "related": "listAlerts", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -39529,122 +39968,38 @@ "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\")", + "description": "the IDs of the alerts", "length": 255, - "name": "startdate", + "name": "ids", + "related": "listAlerts", "required": false, - "type": "date" + "type": "list" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the 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 description of the Backup Offering to be updated", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "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", - "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" }, {}, { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "zone name", - "name": "zonename", + "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": "external ID on the provider side", - "name": "externalid", - "type": "string" - }, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "description for the backup offering", - "name": "description", - "type": "string" - }, - { - "description": "name for the backup offering", - "name": "name", - "type": "string" - }, - { - "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", @@ -39661,16 +40016,12 @@ } ], "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", @@ -39682,7 +40033,11 @@ "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -39690,6 +40045,13 @@ "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 ID of the internal lb vm", "length": 255, @@ -39697,61 +40059,62 @@ "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "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,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, + {}, { - "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 network domain for the router", - "name": "networkdomain", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { "description": "VPC the router belongs to", @@ -39759,187 +40122,133 @@ "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "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": "the Zone ID for the router", - "name": "zoneid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "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", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "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 project name of the address", - "name": "project", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "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 hostname for the router", - "name": "hostname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -39948,97 +40257,82 @@ "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "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 gateway of IPv6 network", + "name": "ip6gateway", "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 gateway of the nic", - "name": "gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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 netmask of the nic", "name": "netmask", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -40047,92 +40341,158 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "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": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "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 hostname for the router", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" } ] }, @@ -40141,24 +40501,17 @@ "isasync": true, "name": "addBrocadeVcsDevice", "params": [ - { - "description": "Hostname of ip address of the Brocade VCS Switch.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "Hostname of ip address of the Brocade VCS Switch.", "length": 255, - "name": "password", + "name": "hostname", "required": true, "type": "string" }, @@ -40169,14 +40522,25 @@ "related": "createPhysicalNetwork", "required": true, "type": "uuid" + }, + { + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], "related": "listBrocadeVcsDevices", "response": [ - {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -40189,12 +40553,12 @@ "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -40205,11 +40569,7 @@ "name": "provider", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -40244,142 +40604,62 @@ "related": "createSecurityGroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "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", + "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": "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "account owning the security group rule", + "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, - { - "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": "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -40387,121 +40667,96 @@ "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 description of the security group", - "name": "description", + "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 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 list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "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" }, { @@ -40510,28 +40765,28 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -40543,42 +40798,147 @@ "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" - }, + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "since": "4.14.0.0" @@ -40589,50 +40949,46 @@ "name": "createDomain", "params": [ { - "description": "Domain UUID, required for adding domain from another Region", + "description": "creates domain with this name", "length": 255, - "name": "domainid", - "required": false, + "name": "name", + "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": "Network domain for networks in the domain", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network domain for networks in the domain", + "description": "Domain UUID, required for adding domain from another Region", "length": 255, - "name": "networkdomain", + "name": "domainid", "required": false, "type": "string" }, { - "description": "creates domain with this name", + "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": "name", - "required": true, - "type": "string" + "name": "parentdomainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "listDomainChildren,listDomains,listDomains", "response": [ + {}, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "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 number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { @@ -40641,201 +40997,180 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the path of the domain", - "name": "path", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "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 templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "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 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 secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "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 public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "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 total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { "description": "the total number of vpcs owned by domain", @@ -40843,38 +41178,63 @@ "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "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 state of the domain", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "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", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" } ] @@ -40885,11 +41245,11 @@ "name": "deleteTags", "params": [ { - "description": "Delete tag by resource type", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "tags", + "required": false, + "type": "map" }, { "description": "Delete tags for resource id(s)", @@ -40899,18 +41259,18 @@ "type": "list" }, { - "description": "Delete tags matching key/value pairs", + "description": "Delete tag by resource type", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "resourcetype", + "required": true, + "type": "string" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -40918,16 +41278,16 @@ "type": "string" }, {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.0.0" @@ -40937,14 +41297,6 @@ "isasync": false, "name": "listExternalFirewalls", "params": [ - { - "description": "zone Id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -40965,39 +41317,36 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - }, { "description": "the public security zone of the external firewall", "name": "publiczone", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { @@ -41006,82 +41355,97 @@ "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, {}, + {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the ID of the network device", - "name": "id", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { "description": "the 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 network device", + "name": "id", + "type": "string" } ] }, { - "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", - "isasync": false, - "name": "login", + "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": "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": "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": "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": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "domain", + "name": "livepatch", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence", + "description": "The ID of the network to restart.", "length": 255, - "name": "domainId", - "required": false, - "type": "long" + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "Username", + "description": "If cleanup old network elements", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "cleanup", + "required": false, + "type": "boolean" } ], - "related": "", "response": [ + {}, + {}, { - "description": "the time period before the session has expired", - "name": "timeout", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -41090,31 +41454,53 @@ "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "login", + "params": [ { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Username", + "length": 255, + "name": "username", + "required": true, "type": "string" }, - {}, { - "description": "Username", - "name": "username", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, + { + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ { "description": "User ID", "name": "userid", @@ -41126,8 +41512,13 @@ "type": "integer" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { @@ -41135,74 +41526,51 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { "description": "last name of the user", "name": "lastname", "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", - "type": "boolean" + "description": "user time zone", + "name": "timezone", + "type": "string" }, { - "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": "user time zoneoffset", + "name": "timezoneoffset", + "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", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Username", + "name": "username", "type": "string" } ] @@ -41213,32 +41581,32 @@ "name": "listHypervisorCapabilities", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "page", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the hypervisor capability", @@ -41251,11 +41619,21 @@ ], "related": "", "response": [ + { + "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" + }, {}, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { "description": "the maximum number of Hosts per cluster for this hypervisor", @@ -41263,13 +41641,13 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -41278,36 +41656,26 @@ "type": "integer" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" }, - {}, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "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", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - } + {} ], "since": "3.0.0" }, @@ -41316,6 +41684,13 @@ "isasync": false, "name": "addImageStore", "params": [ + { + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the URL for the image store", "length": 2048, @@ -41330,13 +41705,6 @@ "required": true, "type": "string" }, - { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the Zone ID for the image store", "length": 255, @@ -41356,45 +41724,40 @@ "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the name of the image store", + "name": "name", "type": "string" }, {}, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the host's currently used disk size", @@ -41402,92 +41765,116 @@ "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" + }, + {}, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" } ], "since": "4.2.0" }, { - "description": "Revoke a certificate alias from a KVM host", + "description": "Revoke a direct download certificate from hosts in a zone", "isasync": false, "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "hypervisor type", + "description": "(optional) hypervisor type", "length": 255, "name": "hypervisor", - "required": true, + "required": false, "type": "string" }, { - "description": "zone to revoke certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "id of the certificate", + "length": 255, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", "required": false, "type": "uuid" }, { - "description": "alias of the SSL certificate", + "description": "(optional) zone to revoke certificate", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], + "related": "provisionTemplateDirectDownloadCertificate", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the host", + "name": "hostname", "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" }, + {}, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" } ], "since": "4.13" @@ -41509,14 +41896,24 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -41524,131 +41921,121 @@ "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the storage pool type", - "name": "type", + "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 scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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 ID of the storage pool", - "name": "id", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod name of the storage pool", + "name": "podname", "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 storage pool", - "name": "name", + "description": "the Zone name of the storage pool", + "name": "zonename", "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": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" } ], "since": "4.16.0" @@ -41659,28 +42046,30 @@ "name": "deleteProjectRole", "params": [ { - "description": "ID of the project from where the role is to be deleted", + "description": "ID of the project role to be deleted", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, "type": "uuid" }, { - "description": "ID of the project role to be deleted", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "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", @@ -41691,8 +42080,6 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -41707,16 +42094,16 @@ "name": "getSolidFireAccountId", "params": [ { - "description": "CloudStack Account UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "accountid", + "name": "storageid", "required": true, "type": "string" }, { - "description": "Storage Pool UUID", + "description": "CloudStack Account UUID", "length": 255, - "name": "storageid", + "name": "accountid", "required": true, "type": "string" } @@ -41724,11 +42111,6 @@ "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", @@ -41739,6 +42121,11 @@ "description": "SolidFire Account ID", "name": "solidFireAccountId", "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -41758,15 +42145,21 @@ ], "related": "", "response": [ + {}, { - "description": "the ID of the role permission", - "name": "id", + "description": "the description of the role permission", + "name": "description", "type": "string" }, {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { @@ -41774,30 +42167,24 @@ "name": "rolename", "type": "string" }, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, { "description": "the permission type of the api name or wildcard rule, allow/deny", "name": "permission", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" } ], @@ -41822,13 +42209,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "network service name to list providers and capabilities of", "length": 255, @@ -41842,6 +42222,13 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", @@ -41850,29 +42237,24 @@ "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": "the provider name", + "name": "name", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -41881,29 +42263,38 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" } ], "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, { "description": "the capability value", "name": "value", @@ -41913,11 +42304,6 @@ "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" @@ -41926,7 +42312,8 @@ "description": "the service name", "name": "name", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -41945,22 +42332,22 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the 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", @@ -41974,6 +42361,13 @@ "isasync": false, "name": "listDedicatedGuestVlanRanges", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list dedicated guest vlan ranges by id", "length": 255, @@ -41983,11 +42377,11 @@ "type": "uuid" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "zone of the guest VLAN range", @@ -41998,27 +42392,19 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "project who will own the guest VLAN range", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "physical network id of the guest VLAN range", + "description": "the dedicated guest vlan range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", @@ -42029,53 +42415,43 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the dedicated guest vlan range", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "guestvlanrange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "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", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network of the guest vlan range", "name": "physicalnetworkid", "type": "long" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { @@ -42084,30 +42460,41 @@ "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 ID of the guest VLAN range", - "name": "id", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, + {}, + {}, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -42116,6 +42503,14 @@ "isasync": true, "name": "addNetworkServiceProvider", "params": [ + { + "description": "the Physical Network ID to add the provider to", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "the list of services to be enabled for this physical network service provider", "length": 255, @@ -42131,14 +42526,6 @@ "required": false, "type": "uuid" }, - { - "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, @@ -42149,52 +42536,52 @@ ], "related": "listNetworkServiceProviders,listTrafficTypes", "response": [ + { + "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" }, + {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the provider name", + "name": "name", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - {}, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { "description": "state of the network provider", "name": "state", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" } ], "since": "3.0.0" @@ -42204,29 +42591,6 @@ "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": "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -42242,9 +42606,9 @@ "type": "integer" }, { - "description": "list network ACL items by action", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "action", + "name": "traffictype", "required": false, "type": "string" }, @@ -42256,19 +42620,19 @@ "type": "string" }, { - "description": "list network ACL items by network ID", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -42279,7 +42643,14 @@ "type": "uuid" }, { - "description": "list objects by project", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", @@ -42287,28 +42658,29 @@ "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list network ACL items by protocol", "length": 255, - "name": "traffictype", + "name": "protocol", "required": false, "type": "string" }, { - "description": "", + "description": "list network ACL items by network ID", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network ACL items by protocol", + "description": "list network ACL items by action", "length": 255, - "name": "protocol", + "name": "action", "required": false, "type": "string" }, { - "description": "If set to false, list only 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, @@ -42321,72 +42693,37 @@ "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" - } - ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" }, { - "description": "is rule for display to the regular user", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + } + ], + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "response": [ { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -42395,13 +42732,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -42410,13 +42747,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -42428,23 +42760,54 @@ "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": "Number of the ACL Item", - "name": "number", + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + {}, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "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 ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { @@ -42453,26 +42816,50 @@ "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, - {}, - {}, { "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" - } - ] - }, - { - "description": "Delete site to site vpn gateway", + }, + {}, + { + "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": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + } + ] + }, + { + "description": "Delete site to site vpn gateway", "isasync": true, "name": "deleteVpnGateway", "params": [ @@ -42486,11 +42873,6 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", @@ -42498,16 +42880,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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -42516,86 +42903,86 @@ "name": "createServiceOffering", "params": [ { - "description": "io requests read rate of the disk offering", + "description": "min iops of the compute offering", "length": 255, - "name": "iopsreadrate", + "name": "miniops", "required": false, + "since": "4.4", "type": "long" }, { - "description": "the CPU number of the service offering", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "cpunumber", + "name": "maxcpunumber", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "The minimum memroy size of the custom service offering in MB", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "minmemory", + "name": "customizediops", "required": false, - "since": "4.13", - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the Root disk size in GB.", "length": 255, - "name": "systemvmtype", + "name": "rootdisksize", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "storagetype", "required": false, - "since": "4.15", - "type": "uuid" + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "bytesreadratemax", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "description": "the HA for the service offering", "length": 255, - "name": "isvolatile", + "name": "offerha", "required": false, "type": "boolean" }, { - "description": "the total memory of the service offering in MB", + "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": "memory", + "name": "deploymentplanner", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "the CPU number of the service offering", "length": 255, - "name": "dynamicscalingenabled", + "name": "cpunumber", "required": false, - "since": "4.16", - "type": "boolean" + "type": "integer" }, { - "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": "is this a system vm offering", "length": 255, - "name": "deploymentplanner", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "length (in seconds) of the burst", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.4", - "type": "integer" + "type": "long" }, { "description": "burst requests read rate of the disk offering", @@ -42604,6 +42991,20 @@ "required": false, "type": "long" }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "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": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, @@ -42612,63 +43013,64 @@ "type": "integer" }, { - "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, "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "max iops of the compute offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "maxiops", "required": false, - "type": "list" + "since": "4.4", + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "iopswriteratemaxlength", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "long" + "since": "4.17", + "type": "uuid" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "maxcpunumber", + "name": "byteswriterate", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemax", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "min iops of the compute offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "miniops", + "name": "iopswriterate", "required": false, - "since": "4.4", "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": "details for planner, used to store specific parameters", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "serviceofferingdetails", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "map" + "since": "4.4", + "type": "integer" }, { "description": "the ID of the containing zone(s), null for public offerings", @@ -42680,91 +43082,91 @@ "type": "list" }, { - "description": "the tags for this service offering.", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "tags", + "name": "serviceofferingdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "the host tag for this service offering.", "length": 255, - "name": "cachemode", + "name": "hosttags", "required": false, - "since": "4.14", "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the name of the service offering", "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "the tags for this service offering.", "length": 255, - "name": "bytesreadrate", + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "the HA for the service offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "offerha", + "name": "minmemory", "required": false, - "type": "boolean" + "since": "4.13", + "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "bytesreadratemaxlength", + "name": "dynamicscalingenabled", "required": false, - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "description": "the host tag for this service offering.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "hosttags", + "name": "iopsreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "limitcpuuse", + "name": "customized", "required": false, + "since": "4.13", "type": "boolean" }, { - "description": "Whether service offering size is custom or not", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "customized", + "name": "systemvmtype", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "limitcpuuse", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "The maximum memroy size of the custom service offering in MB", + "description": "length (in seconds) of the burst", "length": 255, - "name": "maxmemory", + "name": "bytesreadratemaxlength", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { "description": "the display text of the service offering", @@ -42774,168 +43176,176 @@ "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "cpuspeed", + "name": "mincpunumber", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "the name of the service offering", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "diskofferingstrictness", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "mincpunumber", + "name": "maxmemory", "required": false, "since": "4.13", "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "provisioningtype", + "name": "memory", "required": false, - "type": "string" + "type": "integer" }, { - "description": "max iops of the compute offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "iopsreadrate", "required": false, - "since": "4.4", "type": "long" }, { - "description": "whether compute offering iops is custom or not", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "customizediops", + "name": "provisioningtype", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the Root disk size in GB.", + "description": "the CPU speed of the service offering in MHz.", "length": 255, - "name": "rootdisksize", + "name": "cpuspeed", "required": false, - "since": "4.15", - "type": "long" + "type": "integer" }, { - "description": "is this a system vm offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "issystem", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "storagetype", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "string" + "since": "4.15", + "type": "uuid" } ], "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", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "is this a system vm offering", + "name": "issystem", "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": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", "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": "data transfer rate in megabits per second allowed.", "name": "networkrate", "type": "integer" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { @@ -42944,8 +43354,13 @@ "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "the memory in MB", + "name": "memory", + "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" }, { @@ -42954,29 +43369,49 @@ "type": "date" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "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": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "name": "provisioningtype", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -42984,66 +43419,55 @@ "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "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": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, - {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -43051,39 +43475,39 @@ "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, { "description": "burst io requests read rate of the disk offering", "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "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": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the id of the service offering", + "name": "id", + "type": "string" } ] }, @@ -43093,9 +43517,17 @@ "name": "copyTemplate", "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": "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": "sourcezoneid", + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + }, + { + "description": "ID of the zone the template is being copied to.", + "length": 255, + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" @@ -43109,17 +43541,9 @@ "type": "uuid" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, - { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" @@ -43128,173 +43552,116 @@ "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "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", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, {}, - {}, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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" - }, - { - "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 id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, + {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "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": "the current status of the latest async job acting 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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { "description": "the name of the secondary storage host for the template", @@ -43302,59 +43669,44 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { "description": "the project name of the template", "name": "project", "type": "string" }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, { "description": "true if the ISO is bootable, false otherwise", "name": "bootable", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "true if this template is a featured template, false otherwise", @@ -43362,38 +43714,28 @@ "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", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { @@ -43402,14 +43744,24 @@ "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "the template ID of the parent template if present", @@ -43422,14 +43774,86 @@ "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" } ] }, @@ -43441,14 +43865,22 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -43458,48 +43890,21 @@ "name": "keyword", "required": false, "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", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, + {}, { "description": "the id of the network", "name": "id", "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 network domain", - "name": "networkdomain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the date this network was created", "name": "created", @@ -43511,53 +43916,98 @@ "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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": "true if network can span multiple zones", - "name": "strechedl2subnet", + "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 name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "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 physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -43566,19 +44016,130 @@ "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "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": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the second DNS for the network", + "name": "dns2", + "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 external id of the network", + "name": "externalid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "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", @@ -43590,28 +44151,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -43620,103 +44186,100 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "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": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability value", - "name": "value", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" }, { "description": "the physical network this belongs to", @@ -43729,24 +44292,36 @@ "type": "string" }, { - "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" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the capability value", + "name": "value", "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" } ], "type": "list" @@ -43754,50 +44329,15 @@ ], "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" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", @@ -43805,95 +44345,19 @@ "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 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", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - {}, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, - { - "description": "true if network 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 first DNS for the network", "name": "dns1", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" } ] }, @@ -43911,19 +44375,12 @@ "type": "uuid" }, { - "description": "account name of the new VM owner.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional project for the new VM owner.", + "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": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "securitygroupids", + "related": "createSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { "description": "id of the VM to be moved", @@ -43937,40 +44394,47 @@ "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", "length": 255, "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "list" }, { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "description": "an optional project for the new VM owner.", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -43978,58 +44442,179 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "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", - "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": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "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 name of the virtual machine", - "name": "name", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 type of the nic", + "name": "type", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -44037,18 +44622,18 @@ "type": "boolean" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -44057,19 +44642,19 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the 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", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the gateway of the nic", @@ -44077,13 +44662,18 @@ "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -44091,107 +44681,72 @@ "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, - { - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -44199,130 +44754,34 @@ "name": "instancename", "type": "string" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "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 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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, { - "description": "the 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": "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", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -44331,8 +44790,8 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -44341,13 +44800,8 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -44356,138 +44810,147 @@ "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the affinity group", + "name": "id", "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 domain name of the affinity group", - "name": "domain", + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, - {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the pool type of the virtual machine", "name": "pooltype", "type": "string" }, - {}, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -44495,36 +44958,31 @@ "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -44533,18 +44991,18 @@ "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44553,74 +45011,52 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the code for the ICMP message response", @@ -44631,29 +45067,46 @@ "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -44662,42 +45115,47 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -44705,21 +45163,36 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 domain ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -44727,23 +45200,28 @@ "name": "description", "type": "string" }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the 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", + "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" }, { @@ -44752,23 +45230,23 @@ "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -44777,54 +45255,39 @@ "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", "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" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { @@ -44833,75 +45296,76 @@ "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - {}, - { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" } ], "since": "3.0.0" @@ -44921,27 +45385,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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.6.0" @@ -44951,6 +45415,13 @@ "isasync": true, "name": "configureNetscalerLoadBalancer", "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": "Netscaler load balancer device ID", "length": 255, @@ -44959,6 +45430,13 @@ "required": true, "type": "uuid" }, + { + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "length": 255, + "name": "inline", + "required": false, + "type": "boolean" + }, { "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, @@ -44973,57 +45451,33 @@ "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "list" - }, - { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", - "length": 255, - "name": "inline", - "required": false, - "type": "boolean" - }, - { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "lbdevicecapacity", - "required": false, - "type": "long" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { @@ -45031,52 +45485,62 @@ "name": "lbdevicededicated", "type": "boolean" }, + {}, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, { "description": "the public interface of the load balancer", "name": "publicinterface", "type": "string" }, - {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 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", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -45086,66 +45550,65 @@ "name": "listOvsElements", "params": [ { - "description": "", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "page", + "name": "nspid", + "related": "listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list ovs elements by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list ovs elements by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list ovs elements by network service provider id", + "description": "list network offerings by enabled state", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "configureOvsElement", "response": [ { - "description": "the 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 service provider id of the provider", - "name": "nspid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, - {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -45155,13 +45618,8 @@ "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -45170,20 +45628,26 @@ "type": "boolean" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the id of the ovs", + "name": "id", "type": "string" - } + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + {} ] }, { @@ -45199,24 +45663,29 @@ "type": "string" }, { - "description": "ucs manager id", + "description": "blade id", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "bladeid", + "related": "associateUcsProfileToBlade", "required": true, "type": "uuid" }, { - "description": "blade id", + "description": "ucs manager id", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" } ], "related": "", "response": [ + { + "description": "cloudstack host id this blade associates to", + "name": "hostid", + "type": "string" + }, { "description": "ucs blade dn", "name": "bladedn", @@ -45227,82 +45696,29 @@ "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", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "cloudstack host id this blade associates to", - "name": "hostid", - "type": "string" - }, - {}, { "description": "ucs manager id", "name": "ucsmanagerid", "type": "string" - } - ] - }, - { - "description": "Deletes user from the project", - "isasync": true, - "name": "deleteUserFromProject", - "params": [ - { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" }, { - "description": "Id of the user to be removed from the project", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "ucs blade id", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } - ], - "since": "4.15.0" + ] }, { "description": "Updates a VMware datacenter details for a zone", @@ -45310,12 +45726,19 @@ "name": "updateVmwareDc", "params": [ { - "description": "The password for specified username.", + "description": "The username required to connect to resource.", "length": 255, - "name": "password", + "name": "username", "required": false, "type": "string" }, + { + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, @@ -45331,13 +45754,6 @@ "required": true, "type": "uuid" }, - { - "description": "The username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "VMware datacenter name.", "length": 255, @@ -45346,23 +45762,23 @@ "type": "string" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "The password for specified username.", "length": 255, - "name": "isrecursive", + "name": "password", "required": false, - "type": "boolean" + "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "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 VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, { @@ -45370,38 +45786,79 @@ "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 associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, - {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" + } + ], + "since": "4.12.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ + { + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "description": "Id of the user to be removed from the project", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], - "since": "4.12.0" + "since": "4.15.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": "the ID of the router", "length": 255, @@ -45409,32 +45866,39 @@ "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "required": true, "type": "uuid" + }, + { + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "type": "boolean" } ], "related": "", "response": [ - { - "description": "the 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 id of the router", + "name": "routerid", "type": "string" }, - {}, - {}, { "description": "the id of the router", "name": "healthchecks", "type": "list" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.14.0" }, @@ -45453,14 +45917,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -45468,18 +45932,14 @@ "related": "", "response": [ { - "description": "num_retries", - "name": "numretries", - "type": "string" - }, - { - "description": "ncc_ip", - "name": "ipaddress", + "description": "id", + "name": "id", "type": "string" }, + {}, { - "description": "id", - "name": "id", + "description": "num_retries", + "name": "numretries", "type": "string" }, { @@ -45487,12 +45947,17 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "ncc_ip", + "name": "ipaddress", + "type": "string" + }, { "description": "uuid", "name": "uuid", @@ -45502,8 +45967,7 @@ "description": "username", "name": "username", "type": "string" - }, - {} + } ] }, { @@ -45515,35 +45979,35 @@ "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", + "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 volume size in GB", + "description": "Verify OK to Shrink", "length": 255, - "name": "size", + "name": "shrinkok", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "New minimum number of IOPS", + "description": "New maximum number of IOPS", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "Verify OK to Shrink", + "description": "New volume size in GB", "length": 255, - "name": "shrinkok", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "New maximum number of IOPS", + "description": "New minimum number of IOPS", "length": 255, - "name": "maxiops", + "name": "miniops", "required": false, "type": "long" }, @@ -45556,136 +46020,173 @@ "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the 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", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "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": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -45693,34 +46194,45 @@ "name": "project", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "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 service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { @@ -45729,120 +46241,69 @@ "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "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", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, + {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -45851,54 +46312,59 @@ "type": "string" }, { - "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": "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 path of the volume", - "name": "path", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { "description": "the date the volume was attached to a VM instance", @@ -45906,41 +46372,44 @@ "type": "date" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, - {}, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" } ] }, @@ -45957,35 +46426,35 @@ "type": "string" }, { - "description": "the project of the affinity group", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "", "required": false, "type": "uuid" }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the project of the affinity group", "length": 255, - "name": "id", - "related": "", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the domain ID of account owning the affinity group", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ @@ -45995,17 +46464,17 @@ "type": "string" }, {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -46028,23 +46497,23 @@ } ], "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on 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", @@ -46068,6 +46537,16 @@ } ], "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", @@ -46079,17 +46558,7 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -46098,6 +46567,14 @@ "isasync": true, "name": "dedicatePod", "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, @@ -46112,22 +46589,13 @@ "related": "listDomainChildren,listDomains,listDomains", "required": true, "type": "uuid" - }, - { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" } ], "related": "listDedicatedPods", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { @@ -46135,19 +46603,15 @@ "name": "id", "type": "string" }, - { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" - }, + {}, { "description": "the Dedication Affinity Group ID of the pod", "name": "affinitygroupid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { @@ -46156,8 +46620,13 @@ "type": "integer" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, {}, @@ -46173,24 +46642,31 @@ "isasync": false, "name": "listNetworkDevice", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "parameters for network device", "length": 255, - "name": "keyword", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -46200,13 +46676,6 @@ "name": "networkdevicetype", "required": false, "type": "string" - }, - { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" } ], "related": "addNetworkDevice", @@ -46216,8 +46685,6 @@ "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -46227,7 +46694,9 @@ "description": "the ID of the network device", "name": "id", "type": "string" - } + }, + {}, + {} ] }, { @@ -46236,19 +46705,26 @@ "name": "updateStorageNetworkIpRange", "params": [ { - "description": "Optional. the vlan the ip range sits on", + "description": "the ending IP address", "length": 255, - "name": "vlan", + "name": "endip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending IP address", + "description": "the netmask for storage network", "length": 255, - "name": "endip", + "name": "netmask", "required": false, "type": "string" }, + { + "description": "Optional. the vlan the ip range sits on", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" + }, { "description": "UUID of storage network ip range", "length": 255, @@ -46263,49 +46739,31 @@ "name": "startip", "required": false, "type": "string" - }, - { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ - {}, { "description": "the Zone uuid of the storage network IP range", "name": "zoneid", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { "description": "the end ip of the storage network IP range", "name": "endip", @@ -46317,18 +46775,29 @@ "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the 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 ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, + {}, + { + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" } ], @@ -46347,6 +46816,13 @@ "required": true, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List project role by project role ID.", "length": 255, @@ -46355,12 +46831,26 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "List project role by project role name.", "length": 255, "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createProjectRole,updateProjectRole", @@ -46370,27 +46860,27 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the name of the role", "name": "name", "type": "string" }, + {}, { "description": "the ID of the role", "name": "id", "type": "string" }, - {}, { "description": "the id of the project", "name": "projectid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the description of the role", @@ -46416,15 +46906,14 @@ ], "related": "addOpenDaylightController", "response": [ - {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { @@ -46432,20 +46921,21 @@ "name": "username", "type": "string" }, + {}, + {}, + { + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the url of the controller api", - "name": "url", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -46461,32 +46951,46 @@ "name": "updateTemplate", "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "isrouting", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "passwordenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the name of the image file", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "sortkey", + "name": "sshkeyenabled", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" }, { "description": "the format for the image", @@ -46496,18 +47000,18 @@ "type": "string" }, { - "description": "the type of the template", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "templatetype", + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "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": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "cleanupdetails", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "the ID of the OS type that best represents the OS of this image.", @@ -46518,92 +47022,73 @@ "type": "uuid" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the image file", + "description": "the type of the template", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "templatetype", "required": false, "type": "string" }, { - "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "sort key of the template, integer", "length": 255, - "name": "isdynamicallyscalable", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the image file", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "the name of the image file", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "name", + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" } ], "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", - "type": "string" - }, - { - "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 name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", @@ -46611,90 +47096,146 @@ "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, - {}, { "description": "the name of the OS type for this template.", "name": "ostypename", "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 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 project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, + {}, { - "description": "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 type of the template", - "name": "templatetype", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -46703,176 +47244,125 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template name", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" }, { - "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 physical size of the template", - "name": "physicalsize", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "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 template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "checksum of the template", - "name": "checksum", + "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": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" } ] }, @@ -46882,18 +47372,12 @@ "name": "createVlanIpRange", "params": [ { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" - }, - { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the network id", "length": 255, - "name": "startipv6", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", @@ -46903,72 +47387,63 @@ "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address in the VLAN IP range", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "endip", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "the physical network id", "length": 255, - "name": "forsystemvms", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the network id", + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the physical network id", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "endipv6", "required": false, - "type": "uuid" + "type": "string" }, { "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", @@ -46985,23 +47460,31 @@ "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "gateway", + "name": "startip", "required": false, "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "netmask", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "vlan", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", "required": false, "type": "string" }, @@ -47012,44 +47495,51 @@ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" } ], "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ { - "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 domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the 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 Zone ID of the VLAN IP range", @@ -47057,90 +47547,95 @@ "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, + {}, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the Pod ID for the VLAN 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 VLAN IP range", - "name": "netmask", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" } ] @@ -47150,6 +47645,14 @@ "isasync": true, "name": "updateVpnConnection", "params": [ + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "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, @@ -47165,56 +47668,39 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "required": true, - "type": "uuid" } ], "related": "createVpnConnection,listVpnConnections", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "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 domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { @@ -47223,19 +47709,23 @@ "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, - {}, { - "description": "the project name", - "name": "project", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -47244,40 +47734,39 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, - {}, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the project name", + "name": "project", + "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 UUID of the latest async job acting on this object", @@ -47285,13 +47774,13 @@ "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -47299,19 +47788,25 @@ "name": "dpd", "type": "boolean" }, + {}, { - "description": "the public IP address", - "name": "publicip", + "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", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" } ], @@ -47323,11 +47818,12 @@ "name": "listPaloAltoFirewallNetworks", "params": [ { - "description": "", + "description": "palo alto balancer device ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "lbdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -47337,174 +47833,102 @@ "type": "string" }, { - "description": "palo alto balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ - {}, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, { "description": "VPC the network belongs to", "name": "vpcid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", - "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", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "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 displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, + {}, { "description": "the network domain", "name": "networkdomain", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "The routing mode of network offering", + "name": "ip6routing", "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the name of the zone the network belongs to", @@ -47512,53 +47936,39 @@ "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, + {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "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": "ACL name associated with the VPC network", - "name": "aclname", + "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" }, { @@ -47566,28 +47976,28 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -47596,66 +48006,54 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, { "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", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -47663,24 +48061,29 @@ "name": "physicalnetworkid", "type": "string" }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], @@ -47690,14 +48093,36 @@ "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 details of the network", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the owner of the network", @@ -47705,9 +48130,9 @@ "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "true if network can span multiple zones", @@ -47715,19 +48140,19 @@ "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { "description": "the id of the network", @@ -47735,33 +48160,103 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "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 internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "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" }, { @@ -47770,14 +48265,54 @@ "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" } ] }, @@ -47796,12 +48331,6 @@ ], "related": "", "response": [ - { - "description": "The path field for the volume", - "name": "path", - "type": "string" - }, - {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -47812,6 +48341,12 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" } ] }, @@ -47821,9 +48356,9 @@ "name": "listManagementServers", "params": [ { - "description": "the name of the management server", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -47838,21 +48373,21 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the management server", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -47860,36 +48395,71 @@ "related": "", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "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 name of the management server", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + {}, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, {}, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, { "description": "the ID of the management server", "name": "id", "type": "string" }, { - "description": "the name of the management server", - "name": "name", + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -47898,6 +48468,13 @@ "isasync": false, "name": "updateInstanceGroup", "params": [ + { + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Instance group ID", "length": 255, @@ -47905,30 +48482,35 @@ "related": "createInstanceGroup,updateInstanceGroup", "required": true, "type": "uuid" - }, - { - "description": "new instance group name", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "createInstanceGroup", "response": [ + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -47937,8 +48519,13 @@ "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the name of the instance group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { @@ -47951,596 +48538,435 @@ "name": "account", "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", - "type": "string" - }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" } ] }, { - "description": "List ucs manager", - "isasync": false, - "name": "listUcsManagers", + "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "isasync": true, + "name": "changeOfferingForVolume", "params": [ { - "description": "the zone id", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "automigrate", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "Verify OK to Shrink", "length": 255, - "name": "pagesize", + "name": "shrinkok", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the ucs manager", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", + "name": "miniops", "required": false, + "type": "long" + }, + { + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "keyword", + "name": "maxiops", "required": false, - "type": "string" + "type": "long" }, { - "description": "", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "page", + "name": "size", "required": false, - "type": "integer" + "type": "long" + }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" } ], - "related": "addUcsManager", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ + {}, { - "description": "the name of ucs manager", - "name": "name", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the ucs manager", - "name": "id", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, - {}, { - "description": "the url of ucs manager", - "name": "url", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", - "params": [ - { - "description": "The ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the service offering ID to apply to the domain router", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", - "response": [ + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { - "description": "the project name of the address", - "name": "project", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the Pod name for the router", - "name": "podname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "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 version of template", - "name": "version", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "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 ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the 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": "the gateway of the nic", - "name": "gateway", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", - "params": [ + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, + "description": "shared or local storage", + "name": "storagetype", "type": "string" - } - ], - "related": "addLdapConfiguration", - "response": [ - {}, - { - "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", @@ -48548,1635 +48974,1892 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {}, { - "description": "linked domain", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" } ], - "since": "4.2.0" + "since": "4.17" }, { - "description": "Updates the volume.", - "isasync": true, - "name": "updateVolume", + "description": "List the uploaded certificates for direct download templates", + "isasync": false, + "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "The state of the volume", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "state", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.3", - "type": "string" + "type": "uuid" }, { - "description": "Destination storage pool UUID for the volume", + "description": "list direct download certificate by ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "The path of the volume", + "description": "", "length": 255, - "name": "path", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The chain info of the volume", - "length": 255, - "name": "chaininfo", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "new name of the volume", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the ID of the disk volume", + "description": "", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "displayvolume", + "name": "listhosts", "required": false, "type": "boolean" } ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "uploadTemplateDirectDownloadCertificate", "response": [ { - "description": "the path of the volume", - "name": "path", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, + {}, { - "description": "the status of the volume", - "name": "status", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "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 direct download certificate version", + "name": "version", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", + "params": [ { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the ID of the ucs manager", + "length": 255, + "name": "id", + "related": "listUcsManagers,addUcsManager", + "required": false, + "type": "uuid" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the zone id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addUcsManager", + "response": [ + { + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Upgrades domain router to a new service offering", + "isasync": false, + "name": "changeServiceForRouter", + "params": [ { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, + "description": "the service offering ID to apply to the domain router", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", + "response": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "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 Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "set" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the account associated with the router", + "name": "account", + "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": "state of the virtual machine", - "name": "vmstate", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, - {} - ] - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "createProjectRole", - "params": [ { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": true, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - } - ], - "related": "updateProjectRole", - "response": [ + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, { - "description": "the description of the role", - "name": "description", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the role", + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" } - ], - "since": "4.15.0" + ] }, { - "description": "Lists traffic types of a given physical network.", + "description": "Remove an Ldap Configuration", "isasync": false, - "name": "listTrafficTypes", + "name": "deleteLdapConfiguration", "params": [ { - "description": "", + "description": "port", "length": 255, - "name": "page", + "name": "port", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "", + "description": "linked domain", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "Hostname", "length": 255, - "name": "keyword", - "required": false, + "name": "hostname", + "required": true, "type": "string" } ], - "related": "listNetworkServiceProviders", + "related": "addLdapConfiguration", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" }, { - "description": "the provider name", - "name": "name", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - {}, {}, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" } ], - "since": "3.0.0" + "since": "4.2.0" }, { - "description": "Updates account information for the authenticated user", - "isasync": false, - "name": "updateAccount", + "description": "Updates the volume.", + "isasync": true, + "name": "updateVolume", "params": [ { - "description": "Account UUID", + "description": "The path of the volume", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Current account name", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "account", + "name": "displayvolume", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "New name for the account", + "description": "The chain info of the volume", "length": 255, - "name": "newname", + "name": "chaininfo", "required": false, + "since": "4.4", "type": "string" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "The state of the volume", "length": 255, - "name": "networkdomain", + "name": "state", "required": false, + "since": "4.3", "type": "string" }, { - "description": "Details for the account used to store specific parameters", + "description": "new name of the volume", "length": 255, - "name": "accountdetails", + "name": "name", "required": false, - "type": "map" + "since": "4.16", + "type": "string" }, { - "description": "The UUID of the dynamic role to set for the account", + "description": "the ID of the disk volume", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "The UUID of the domain where the account exists", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "Destination storage pool UUID for the volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "uuid" } ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "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", - "type": "string" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the Domain the account belongs to", + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of resource tags associated", + "name": "tags", "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": "the api key of the user", - "name": "apikey", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the domain name of the user", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the account name of the user", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the domain ID of the user", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the project name where tag belongs to", + "name": "project", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "name of the virtual machine", + "name": "vmname", "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": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, - {}, - {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "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", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the date when this account was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" - } - ] - }, - { - "description": "Adds secondary storage.", - "isasync": false, - "name": "addSecondaryStorage", - "params": [ - { - "description": "the Zone ID for the secondary storage", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" }, { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "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", + "description": "the ID of 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 of the image store", - "name": "url", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "size of the disk volume", + "name": "size", "type": "long" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" } ] }, { - "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "description": "Lists traffic types of a given physical network.", "isasync": false, - "name": "updateVirtualMachine", + "name": "listTrafficTypes", "params": [ { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" - }, - { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "description": "", "length": 255, - "name": "isdynamicallyscalable", + "name": "page", "required": false, - "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" + "type": "integer" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "List by keyword", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "user generated name", + "description": "the Physical Network ID", "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listNetworkServiceProviders", + "response": [ { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", - "length": 255, - "name": "name", - "required": false, - "since": "4.4", + "description": "uuid of the network provider", + "name": "id", "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": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the provider name", + "name": "name", "type": "string" }, + {}, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, + {}, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "createProjectRole", + "params": [ + { + "description": "ID of project where role is being created", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "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": "The description of the Project role", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "description", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the OS type that best represents this VM.", + "description": "creates a project role with this unique name", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "updateProjectRole", "response": [ + {}, + {}, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the description of the role", + "name": "description", "type": "string" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", + "params": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "The UUID of the dynamic role to set for the account", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, - {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "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 total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + } + ] + }, + { + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", + "params": [ + { + "description": "the Zone ID for the secondary storage", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { @@ -50185,511 +50868,269 @@ "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the protocol of the image store", + "name": "protocol", + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the Zone ID of the image store", "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", - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the name of the image store", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "isasync": false, + "name": "updateVirtualMachine", + "params": [ + { + "description": "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": "an optional field whether to the display the vm to the end user or not.", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, "name": "displayvm", + "required": false, "type": "boolean" }, { - "description": "the 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 ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" }, - {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "instance name of the user vm", + "length": 255, + "name": "instancename", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "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, + "since": "4.4", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "user generated name", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" + } + ], + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "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": "publicipid", + "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "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": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the netmask of the nic", + "name": "netmask", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -50698,24 +51139,19 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "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": "IP addresses associated with NIC found for unmanaged VM", @@ -50723,96 +51159,106 @@ "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "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 gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "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 memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -50821,209 +51267,223 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - } - ] - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ - { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - }, - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "Disables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Disables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "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 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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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 ID of the role", - "name": "roleid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "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", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "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 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": "the name of the role", - "name": "rolename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + {}, { - "description": "the state of the account", - "name": "state", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -51032,1519 +51492,2188 @@ "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "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 name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "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": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the group ID of the virtual machine", + "name": "groupid", "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", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user name", - "name": "username", - "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": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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" + } + ], + "type": "set" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain name of the security group", + "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 date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the description of the security group", + "name": "description", "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" } ], - "type": "list" + "type": "set" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "State of the Service from LB rule", + "name": "servicestate", + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" } ] }, { - "description": "Lists domains and provides detailed information for listed domains", - "isasync": false, - "name": "listDomains", + "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", "params": [ { - "description": "flag to display the resource icon for domains", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "List domain by domain name.", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "name", + "name": "destcidrlist", "required": false, + "type": "list" + }, + { + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "details", + "name": "fordisplay", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "pagesize", + "name": "startport", "required": false, "type": "integer" }, { - "description": "List domain by domain ID.", + "description": "error code for this ICMP message", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "icmpcode", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "keyword", + "name": "cidrlist", "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": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "listall", + "name": "endport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List domains by domain level.", + "description": "type of the ICMP message being sent", "length": 255, - "name": "level", + "name": "icmptype", "required": false, "type": "integer" } ], - "related": "listDomainChildren,listDomains", + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "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 templates available to be created by this domain", - "name": "templateavailable", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "list" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" + } + ] + }, + { + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", + "params": [ + { + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, + "type": "boolean" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Account id", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "Disables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "createAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "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 name", + "name": "username", + "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 name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "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" + } + ], + "type": "list" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "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 domain", - "name": "primarystorageavailable", + "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) the domain can own", - "name": "secondarystoragelimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, + {}, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "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 available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "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 state of the account", + "name": "state", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, - {}, { - "description": "the name of the domain", + "description": "the name of the account", "name": "name", "type": "string" }, - {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the state of the domain", - "name": "state", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain 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 cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "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": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" - } - ] - }, - { - "description": "Updates a network", - "isasync": true, - "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 total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the new display text for the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", - "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", - "length": 255, - "name": "hideipaddressusage", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, + {}, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, - "type": "boolean" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "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 total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the total number of networks the account can own", + "name": "networklimit", + "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": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the network domain", + "name": "networkdomain", "type": "string" - }, + } + ] + }, + { + "description": "Lists domains and provides detailed information for listed domains", + "isasync": false, + "name": "listDomains", + "params": [ { - "description": "the id of the network", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "List domain by domain ID.", + "length": 255, + "name": "id", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List domain by domain name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "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 network's netmask", - "name": "netmask", - "type": "string" + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, - {}, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "required": false, + "type": "integer" + } + ], + "related": "listDomainChildren,listDomains", + "response": [ + { + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network domain", + "name": "networkdomain", "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 total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "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": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the path of the domain", + "name": "path", "type": "string" }, + {}, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "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", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" } ] }, { - "description": "Lists VM backups", - "isasync": false, - "name": "listBackups", + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", "params": [ { - "description": "id of the VM", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "guestvmcidr", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "network domain", "length": 255, - "name": "keyword", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "pagesize", + "name": "changecidr", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", "length": 255, - "name": "account", + "name": "updateinsequence", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "Setting this to true will cause a forced network update,", "length": 255, - "name": "page", + "name": "forced", "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "isrecursive", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "id of the backup", + "description": "the ID of the network", "length": 255, "name": "id", - "related": "updateBackupSchedule,listBackups", - "required": false, + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "list backups by zone id", + "description": "the new name for the network", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "displaynetwork", + "required": false, + "type": "boolean" + }, + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "listall", + "name": "hideipaddressusage", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the new display text for the network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "updateBackupSchedule", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "backup type", - "name": "type", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, - {}, { - "description": "account name", - "name": "account", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "zone id", - "name": "zoneid", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "domain id", - "name": "domainid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "external backup id", - "name": "externalid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "domain name", - "name": "domain", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "backup date", - "name": "created", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "zone name", - "name": "zone", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, - {}, { - "description": "backup offering name", - "name": "backupofferingname", + "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": "backed up volumes", - "name": "volumes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" - } - ], - "since": "4.14.0" - }, - { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", - "response": [ + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, { - "description": "description of usage type", - "name": "description", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, - {}, - {}, { - "description": "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "List Backup and Recovery provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "the CA service provider name", + "description": "the name of the network", "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the description of the CA service provider", - "name": "description", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", - "params": [ - { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "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": "state of the network", + "name": "state", + "type": "string" }, { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the network's gateway", + "name": "gateway", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", - "params": [ + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "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 network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, + "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 objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + {}, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "usage type", + "name": "usagetypeid", + "type": "integer" + }, + {}, + { + "description": "description of usage type", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteTemplate", + "params": [ + { + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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 all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "list network ACLs by VPC ID", @@ -52554,11 +53683,32 @@ "required": false, "type": "uuid" }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list 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" }, @@ -52570,52 +53720,95 @@ "required": false, "type": "uuid" }, + { + "description": "list network ACLs by specified name", + "length": 255, + "name": "name", + "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" + }, + { + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" + }, + { + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" } ], "related": "createNetworkACLList", "response": [ {}, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Description of the ACL", + "name": "description", + "type": "string" }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", "type": "string" }, + { + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the Name of the ACL", "name": "name", "type": "string" }, + {}, { "description": "the ID of the ACL", "name": "id", "type": "string" }, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Description of the ACL", - "name": "description", - "type": "string" } ] }, @@ -52636,49 +53829,43 @@ "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": "display name of the os on volume", + "name": "osdisplayname", + "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "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": "type of the disk volume", + "name": "volumetype", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -52687,47 +53874,54 @@ "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, + {}, + {}, { - "description": "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": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, { "description": "the list of resource tags associated", "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 key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -52741,21 +53935,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -52764,54 +53958,53 @@ "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, - {}, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "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 project name of the snapshot", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" } ] @@ -52832,26 +54025,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": "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" } ] }, @@ -52869,42 +54062,37 @@ "type": "string" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, + "type": "uuid" } ], "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 vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -52912,10 +54100,14 @@ "name": "vpcname", "type": "string" }, - {}, { - "description": "the owner", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -52924,36 +54116,37 @@ "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - } + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + {} ], "since": "4.4" }, @@ -52973,26 +54166,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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {} ] }, @@ -53002,10 +54195,10 @@ "name": "deleteSecurityGroup", "params": [ { - "description": "the domain ID of account owning the security group", + "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "createSecurityGroup", "required": false, "type": "uuid" }, @@ -53018,19 +54211,19 @@ "type": "uuid" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "the domain ID of account owning the security group", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "the account of the security group. Must be specified with domain ID", "length": 255, - "name": "id", - "related": "createSecurityGroup", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The ID of the security group. Mutually exclusive with id parameter", @@ -53041,25 +54234,25 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} @@ -53071,10 +54264,10 @@ "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" }, @@ -53095,10 +54288,10 @@ "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" } @@ -53106,98 +54299,123 @@ "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": "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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": "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -53205,141 +54423,154 @@ "name": "hypervisor", "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 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 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", - "type": "integer" - }, - { - "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" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -53347,34 +54578,29 @@ "name": "domainid", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 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" } ], @@ -53386,26 +54612,9 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -53418,67 +54627,94 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "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 type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -53487,22 +54723,72 @@ "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" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -53512,8 +54798,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -53522,28 +54813,28 @@ "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": "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": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -53552,198 +54843,58 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": " 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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the netmask of the nic", + "name": "netmask", "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -53751,30 +54902,20 @@ "name": "isdefault", "type": "boolean" }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "the extra dhcp options on the nic", @@ -53782,13 +54923,8 @@ "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -53796,44 +54932,39 @@ "name": "ip6address", "type": "string" }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "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 ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -53852,13 +54983,23 @@ "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -53867,75 +55008,75 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the 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": "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 name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -53944,13 +55085,13 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -53959,71 +55100,103 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + {}, { "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "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 total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { @@ -54032,28 +55205,48 @@ "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "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 ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -54073,6 +55266,7 @@ } ], "response": [ + {}, {}, { "description": "any text associated with the success or failure", @@ -54084,17 +55278,16 @@ "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" + } ] }, { @@ -54105,47 +55298,47 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "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": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addBaremetalRct", "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": "url", "name": "url", "type": "string" }, - {}, { - "description": "id of rct", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of rct", + "name": "id", "type": "string" } ] @@ -54163,12 +55356,33 @@ "type": "boolean" }, { - "description": "true if the template requres HVM, false otherwise", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, + { + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "32 or 64 bit", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, { "description": "create template for the project", "length": 255, @@ -54178,18 +55392,18 @@ "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", + "description": "the name of the template", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "32 or 64 bit", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "bits", + "name": "requireshvm", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the tag for this template.", @@ -54199,19 +55413,19 @@ "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": true, + "type": "uuid" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", @@ -54222,34 +55436,12 @@ "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "isdynamicallyscalable", + "name": "isfeatured", "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.", - "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", - "required": false, - "type": "string" - }, { "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", "length": 255, @@ -54259,18 +55451,12 @@ "type": "uuid" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", "length": 255, - "name": "details", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "map" + "type": "uuid" }, { "description": "true if the template supports the password reset feature; default is false", @@ -54278,106 +55464,22 @@ "name": "passwordenabled", "required": false, "type": "boolean" + }, + { + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "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", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -54388,13 +55490,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -54403,47 +55505,47 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "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": "true if the template is managed across all Zones, false otherwise", @@ -54451,182 +55553,233 @@ "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "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 the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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", - "isasync": true, - "name": "restoreBackup", - "params": [ + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, { - "description": "ID of the backup", - "length": 255, + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template ID", "name": "id", - "related": "updateBackupSchedule", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "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 operation is executed successfully", - "name": "success", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, - {} - ], - "since": "4.14.0" + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + } + ] }, { "description": "Lists dedicated clusters.", @@ -54642,33 +55795,26 @@ "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.", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "account", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list dedicated clusters by affinity group", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the cluster", @@ -54681,47 +55827,54 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "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 Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "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 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 dedicated resource", "name": "id", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { @@ -54738,10 +55891,10 @@ "name": "uploadCustomCertificate", "params": [ { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" }, { @@ -54752,10 +55905,17 @@ "type": "string" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + }, + { + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { @@ -54764,34 +55924,27 @@ "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" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -54809,26 +55962,26 @@ ], "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", - "type": "integer" - }, { "description": "the description of the CA service provider", "name": "description", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CA service provider name", + "name": "name", "type": "string" } ], @@ -54850,26 +56003,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "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,45 +56032,48 @@ "name": "listPortForwardingRules", "params": [ { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { - "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 resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "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": "the ID of IP address of the port forwarding services", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -54930,68 +56086,71 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule", + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "list port forwarding rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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": "", + "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": "updatePortForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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" }, { @@ -55000,32 +56159,37 @@ "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -55034,18 +56198,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -55054,53 +56218,41 @@ "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", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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 public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -55109,24 +56261,25 @@ "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 ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -55159,21 +56312,13 @@ "name": "gateway", "type": "string" }, - { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" - }, - { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" - }, + {}, { "description": "CIDR of the Pod", "name": "cidr", "type": "string" }, + {}, { "description": "the ID of the pod the IP address belongs to", "name": "podid", @@ -55184,23 +56329,31 @@ "name": "hostmac", "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 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": "the ID of the nic", + "name": "nicid", + "type": "long" }, { "description": "Allocated IP address", "name": "ipaddress", "type": "string" - }, - {} + } ] }, { @@ -55219,40 +56372,29 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the 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", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -55260,19 +56402,31 @@ "name": "description", "type": "string" }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, + {}, + {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { @@ -55280,10 +56434,9 @@ "name": "enabled", "type": "boolean" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" } ], @@ -55295,45 +56448,38 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "true for featured template/iso, false otherwise", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "isfeatured", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "accounts", + "name": "op", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isextractable", + "name": "projectids", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "ispublic", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "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" }, @@ -55344,31 +56490,38 @@ "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {}, + {} ] }, { @@ -55383,13 +56536,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "zone Id", "length": 255, @@ -55404,15 +56550,29 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addTrafficMonitor", "response": [ + { + "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 UUID of the latest async job acting on this object", "name": "jobid", @@ -55423,26 +56583,19 @@ "name": "numretries", "type": "string" }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" } ] @@ -55464,65 +56617,116 @@ "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", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 number of cpu this virtual machine is running with", + "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", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { "description": "the total number of network traffic bytes received", @@ -55530,75 +56734,70 @@ "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", "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 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 user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "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": "OS name of the vm", @@ -55606,200 +56805,27 @@ "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", + "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", + "description": "the group ID of the virtual machine", + "name": "groupid", "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", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -55813,8 +56839,8 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -55823,56 +56849,117 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "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 name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -55881,22 +56968,63 @@ "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -55905,13 +57033,90 @@ "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 project id of the group", - "name": "projectid", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -55919,18 +57124,33 @@ "name": "ingressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -55938,38 +57158,43 @@ "name": "cidr", "type": "string" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the 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": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -55978,18 +57203,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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" } ], @@ -55999,107 +57224,10 @@ "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", @@ -56110,9 +57238,9 @@ "name": "egressrule", "response": [ { - "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", @@ -56120,18 +57248,28 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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" }, { @@ -56139,18 +57277,13 @@ "name": "tags", "response": [ { - "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" }, { @@ -56159,13 +57292,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -56179,8 +57307,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -56191,140 +57329,215 @@ ], "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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", + "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" @@ -56335,84 +57548,24 @@ "type": "long" }, { - "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 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", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" } ] }, @@ -56422,13 +57575,20 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "the ID of 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": "id", - "related": "updatePortForwardingRule", - "required": true, + "name": "customid", + "required": false, "since": "4.4", - "type": "uuid" + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "the private end port of the port forwarding rule", @@ -56438,20 +57598,21 @@ "type": "integer" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ID of the port forwarding rule", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, + "name": "id", + "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "required": true, + "since": "4.4", "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "fordisplay", + "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.4", - "type": "boolean" + "type": "uuid" }, { "description": "the private start port of the port forwarding rule", @@ -56467,26 +57628,38 @@ "required": false, "since": "4.5", "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], - "related": "", + "related": "updateIpv6FirewallRule", "response": [ + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "the vm 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" }, { @@ -56495,19 +57668,18 @@ "type": "string" }, { - "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 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 starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -56515,14 +57687,10 @@ "name": "privateendport", "type": "string" }, + {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "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" }, { @@ -56539,24 +57707,14 @@ "name": "key", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -56565,13 +57723,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -56580,37 +57738,36 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -56618,15 +57775,11 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, @@ -56636,33 +57789,33 @@ "name": "listBrocadeVcsDevices", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "Brocade VCS switch ID", "length": 255, - "name": "keyword", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Brocade VCS switch ID", + "description": "", "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the Physical Network ID", @@ -56675,10 +57828,14 @@ ], "related": "", "response": [ - {}, { - "description": "device name", - "name": "brocadedevicename", + "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", "type": "string" }, { @@ -56686,32 +57843,28 @@ "name": "hostname", "type": "string" }, + {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "device name", + "name": "brocadedevicename", "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 Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - } + {} ] }, { @@ -56720,16 +57873,16 @@ "name": "linkDomainToLdap", "params": [ { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "accounttype", - "required": true, - "type": "short" + "name": "ldapdomain", + "required": false, + "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "domain admin username in LDAP ", "length": 255, - "name": "ldapdomain", + "name": "admin", "required": false, "type": "string" }, @@ -56756,29 +57909,23 @@ "type": "string" }, { - "description": "domain admin username in LDAP ", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "admin", - "required": false, - "type": "string" + "name": "accounttype", + "required": true, + "type": "integer" } ], "related": "linkAccountToLdap", "response": [ - { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", - "type": "string" - }, { "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": "name", + "name": "ldapdomain", "type": "string" }, { @@ -56786,25 +57933,31 @@ "name": "jobid", "type": "string" }, + {}, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "name": "name", + "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": "short" + "type": "int" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "type of the name in LDAP which is linke to the domain", + "name": "type", "type": "string" }, + {}, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" } ], @@ -56816,19 +57969,28 @@ "name": "associateIpAddress", "params": [ { - "description": "the VPC you want the IP address to be associated with", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "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" }, { - "description": "IP Address to be associated", + "description": "Deploy VM for the project", "length": 255, - "name": "ipaddress", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the availability zone you want to acquire an public IP address from", @@ -56839,99 +58001,101 @@ "type": "uuid" }, { - "description": "the ID of the domain to associate with this IP address", + "description": "the account to associate with this IP address", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "isportable", + "name": "regionid", + "related": "addRegion,listRegions", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", "length": 255, - "name": "fordisplay", + "name": "isportable", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "The network this IP address should be associated to.", "length": 255, "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "Deploy VM for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "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" } ], "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", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, { "description": "the list of resource tags associated with ip address", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -56945,13 +58109,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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -56960,37 +58124,32 @@ "type": "string" }, { - "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" } ], "type": "list" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { "description": "the VLAN associated with the IP address", @@ -56998,105 +58157,104 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "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 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": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "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 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", - "name": "issourcenat", - "type": "boolean" + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { @@ -57105,23 +58263,18 @@ "type": "string" }, { - "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": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "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", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" } ] @@ -57148,11 +58301,6 @@ ], "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", @@ -57163,6 +58311,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" + }, {}, {} ] @@ -57182,66 +58335,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "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": " 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": "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" } ] }, @@ -57261,52 +58375,52 @@ "description": "The network of the VM the ACL will be created for", "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": "error code for this ICMP message", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "icmpcode", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "type of the ICMP message being sent", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "error code for this ICMP message", "length": 255, - "name": "cidrlist", + "name": "icmpcode", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "reason", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "the ending port of ACL", "length": 255, - "name": "action", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "reason", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "the starting port of ACL", @@ -57316,71 +58430,46 @@ "type": "integer" }, { - "description": "The number of the ACL item, its ordering", + "description": "scl entry action, allow or deny", "length": 255, - "name": "number", + "name": "action", "required": false, - "type": "integer" + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "icmptype", + "name": "number", "required": false, "type": "integer" }, { - "description": "the ending port of ACL", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "endport", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "protocol", + "required": true, + "type": "string" } ], "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", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { @@ -57388,34 +58477,19 @@ "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", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -57424,23 +58498,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -57449,26 +58523,36 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { @@ -57477,19 +58561,49 @@ "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the protocol of the ACL", + "name": "protocol", "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": "Number of the ACL Item", "name": "number", "type": "integer" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -57502,7 +58616,7 @@ "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, "name": "keypair", - "required": true, + "required": false, "type": "string" }, { @@ -57514,11 +58628,12 @@ "type": "uuid" }, { - "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": "The ID of the virtual machine", @@ -57529,196 +58644,65 @@ "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" + }, + { + "description": "names of the ssh key pairs to be used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" } ], "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", - "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 vgpu type used by the virtual machine", - "name": "vgpu", + "description": "State of the Service from LB rule", + "name": "servicestate", "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", + "description": "the list of nics associated with vm", + "name": "nic", "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -57727,13 +58711,13 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -57742,8 +58726,8 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -57751,55 +58735,35 @@ "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", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the name of the corresponding network", @@ -57807,153 +58771,184 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "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 IPv6 address of network", - "name": "ip6address", + "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the project name of the vm", + "name": "project", "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", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "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 project name of the affinity group", - "name": "project", + "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain name of the affinity group", + "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" } ], "type": "set" }, { - "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of 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 name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -57961,9 +58956,19 @@ "name": "securitygroup", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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", @@ -57980,28 +58985,23 @@ "name": "domainid", "type": "string" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the list of 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -58010,8 +59010,13 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -58019,33 +59024,38 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag 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": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -58054,19 +59064,14 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" @@ -58077,76 +59082,41 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "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", @@ -58163,13 +59133,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -58177,40 +59147,80 @@ "name": "resourceid", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, + { + "description": "the 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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -58218,33 +59228,33 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -58253,191 +59263,239 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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" } ], "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -58446,49 +59504,113 @@ "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 speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", + "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "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": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" } ] }, @@ -58498,18 +59620,12 @@ "name": "listVpnCustomerGateways", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "id of the customer gateway", @@ -58520,19 +59636,18 @@ "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,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "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": "", @@ -58542,19 +59657,19 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -58562,29 +59677,31 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "createVpnCustomerGateway", "response": [ { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the project name", - "name": "project", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "if DPD is enabled for customer gateway", @@ -58592,65 +59709,55 @@ "type": "boolean" }, { - "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": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the 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": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 domain name of the owner", - "name": "domain", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "if Force NAT Encapsulation is enabled for customer gateway", "name": "forceencap", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the vpn gateway ID", - "name": "id", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { @@ -58659,14 +59766,24 @@ "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { "description": "name of the customer gateway", @@ -58674,14 +59791,19 @@ "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" } ] }, @@ -58698,11 +59820,12 @@ "type": "string" }, { - "description": "The ending IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "endip", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { "description": "The starting IP address.", @@ -58712,12 +59835,11 @@ "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The ending IP address.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "endip", "required": true, - "type": "uuid" + "type": "string" } ], "response": [ @@ -58726,22 +59848,22 @@ "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, {} ], "since": "4.11.0.0" @@ -58752,33 +59874,27 @@ "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 RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "semanticversion", + "name": "minmemory", "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", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" - }, { "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, @@ -58787,53 +59903,43 @@ "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 semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "minmemory", + "name": "semanticversion", + "required": true, + "type": "string" + }, + { + "description": "the minimum number of CPUs to be set with the Kubernetes version", + "length": 255, + "name": "mincpunumber", "required": true, "type": "integer" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ - { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" - }, {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "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 id of the zone in which Kubernetes supported version is available", "name": "zoneid", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" - }, - { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { @@ -58841,44 +59947,60 @@ "name": "mincpunumber", "type": "integer" }, - { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" - }, - { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" - }, { "description": "the enabled or disabled state of the Kubernetes supported version", "name": "state", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Kubernetes semantic version", "name": "semanticversion", "type": "string" }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + }, { "description": "the minimum RAM size in MB needed for the Kubernetes supported version", "name": "minmemory", "type": "integer" }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" + }, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" } ] @@ -58909,17 +60031,17 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -58942,17 +60064,17 @@ "type": "string" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "account", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, + "name": "gslbdomainname", + "required": true, "type": "string" }, { @@ -58964,9 +60086,17 @@ "type": "uuid" }, { - "description": "domain name for the GSLB service.", + "description": "region where the global load balancer is going to be created.", "length": 255, - "name": "gslbdomainname", + "name": "regionid", + "related": "addRegion,listRegions", + "required": true, + "type": "integer" + }, + { + "description": "GSLB service type (tcp, udp, http)", + "length": 255, + "name": "gslbservicetype", "required": true, "type": "string" }, @@ -58978,80 +60108,67 @@ "type": "string" }, { - "description": "region where the global load balancer is going to be created.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" - }, - { - "description": "GSLB service type (tcp, udp, http)", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "gslbservicetype", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "the project name of the load balancer", - "name": "project", - "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", + "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 domain of the load balancer rule", - "name": "domain", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the description of the global load balancer rule", + "name": "description", "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": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the load balancer", + "name": "project", "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 account of the load balancer rule", "name": "account", @@ -59062,33 +60179,8 @@ "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", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -59097,13 +60189,13 @@ "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the description of the load balancer", + "name": "description", + "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { @@ -59117,8 +60209,8 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -59126,53 +60218,28 @@ "name": "cidrlist", "type": "string" }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, { "description": "the public ip address id", "name": "publicipid", "type": "string" }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -59181,59 +60248,114 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "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 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 domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" } ] @@ -59253,27 +60375,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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -59283,32 +60405,16 @@ "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "region ID", + "description": "", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "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": "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" }, @@ -59320,18 +60426,27 @@ "type": "integer" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "region ID", + "length": 255, + "name": "regionid", + "related": "addRegion,listRegions", "required": false, "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "account", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, - "type": "string" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -59341,50 +60456,62 @@ "type": "boolean" }, { - "description": "list objects by project", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the global load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -59392,18 +60519,23 @@ "name": "gslblbmethod", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -59412,13 +60544,28 @@ "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { @@ -59426,13 +60573,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -59440,16 +60582,6 @@ "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", @@ -59466,66 +60598,61 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], "type": "list" }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "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 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", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -59534,61 +60661,52 @@ "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", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" } ], "type": "list" }, { - "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": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "global load balancer rule ID", - "name": "id", + "description": "GSLB service type", + "name": "gslbservicetype", "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": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { @@ -59596,15 +60714,19 @@ "name": "gslbdomainname", "type": "string" }, - {}, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "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" } ] @@ -59631,20 +60753,20 @@ "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", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -59664,26 +60786,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": "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" } ] }, @@ -59693,32 +60815,40 @@ "name": "listTags", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by value", "length": 255, - "name": "account", + "name": "value", "required": false, "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,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by resource type", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourcetype", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list by customer name", + "length": 255, + "name": "customer", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -59729,105 +60859,96 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list by key", "length": 255, - "name": "keyword", + "name": "key", "required": false, "type": "string" }, { - "description": "list by customer name", + "description": "list by resource type", "length": 255, - "name": "customer", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project", + "description": "list by resource id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "resourceid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by key", + "description": "List by keyword", "length": 255, - "name": "key", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "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": "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 value", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "value", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, - {}, - {}, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -59836,8 +60957,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -59846,10 +60967,11 @@ "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", + "type": "string" + }, + {} ], "since": "4.0.0" }, @@ -59869,32 +60991,32 @@ ], "related": "", "response": [ + { + "description": "the id of the container cluster", + "name": "id", + "type": "string" + }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "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", "type": "string" - }, - {}, - { - "description": "the id of the container cluster", - "name": "id", - "type": "string" } ] }, @@ -59922,25 +61044,14 @@ ], "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", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59948,31 +61059,42 @@ "name": "enabled", "type": "boolean" }, + {}, { "description": "the account associated with the provider", "name": "account", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { "description": "the project name of the address", "name": "project", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -59982,33 +61104,9 @@ "name": "createVPC", "params": [ { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the VPC", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "name", + "name": "cidr", "required": true, "type": "string" }, @@ -60028,11 +61126,12 @@ "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "the ID of the VPC offering", "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { "description": "create VPC for the project", @@ -60043,19 +61142,27 @@ "type": "uuid" }, { - "description": "the ID of the VPC offering", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "cidr", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "the display text of the VPC", @@ -60063,27 +61170,128 @@ "name": "displaytext", "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", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "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", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + {}, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "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": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the id of the VPC", + "name": "id", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -60092,67 +61300,56 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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" } ], "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 owner of the VPC", + "name": "account", "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": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { @@ -60160,26 +61357,6 @@ "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", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, { "description": "the date this VPC was created", "name": "created", @@ -60189,29 +61366,24 @@ "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", @@ -60224,32 +61396,37 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, { "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", "type": "boolean" }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, { "description": "the capability name", "name": "name", @@ -60261,16 +61438,10 @@ ], "type": "list" }, - {}, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { "description": "the domain name of the owner", @@ -60278,59 +61449,15 @@ "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, + {}, { "description": "if this VPC has redundant router", "name": "redundantvpcrouter", "type": "boolean" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -60354,23 +61481,23 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -60388,22 +61515,22 @@ } ], "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -60428,28 +61555,28 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "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" + } ] }, { @@ -60457,6 +61584,20 @@ "isasync": false, "name": "listInternalLoadBalancerVMs", "params": [ + { + "description": "the state of the Internal LB VM", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -60465,51 +61606,49 @@ "type": "integer" }, { - "description": "the host ID of the Internal LB VM", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by network id", + "description": "the Zone ID of the Internal LB VM", "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": "list objects by project", + "description": "the name of the Internal LB VM", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "the host ID of the Internal LB VM", "length": 255, - "name": "fetchhealthcheckresults", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "List Internal LB VMs by VPC", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "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": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -60526,56 +61665,51 @@ "type": "boolean" }, { - "description": "the name of the Internal LB VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "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" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "the state of the Internal LB VM", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "state", + "name": "fetchhealthcheckresults", "required": false, - "type": "string" + "since": "4.14", + "type": "boolean" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "List by keyword", "length": 255, - "name": "forvpc", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the ID of the Internal LB VM", @@ -60584,336 +61718,300 @@ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "destroyRouter,listRouters", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the version of template", + "name": "version", "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 first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "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 domain associated with the router", - "name": "domain", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "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": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, - {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "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", - "type": "string" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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 type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -60922,104 +62020,138 @@ "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 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 ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Pod name for the router", + "name": "podname", "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", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, { "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { "description": "the first DNS for the router", "name": "dns1", "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" } ] }, @@ -61028,13 +62160,6 @@ "isasync": false, "name": "listCiscoVnmcResources", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -61050,6 +62175,14 @@ "required": false, "type": "uuid" }, + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -61058,24 +62191,15 @@ "type": "string" }, { - "description": "Cisco VNMC resource ID", + "description": "", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, - {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -61084,13 +62208,21 @@ }, {}, {}, - {} - ] - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", + {}, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", "params": [ { "description": "Delete detail by resource type", @@ -61100,43 +62232,43 @@ "type": "string" }, { - "description": "Delete details matching key/value pairs", + "description": "Delete details for resource id", "length": 255, - "name": "key", - "required": false, + "name": "resourceid", + "required": true, "type": "string" }, { - "description": "Delete details for resource id", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "resourceid", - "required": true, + "name": "key", + "required": false, "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "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" + }, + {} ] }, { @@ -61147,16 +62279,23 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list os by description", + "description": "list by Os type Id", "length": 255, - "name": "description", + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { @@ -61168,47 +62307,24 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by Os type Id", + "description": "list os by description", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "description", "required": false, - "type": "uuid" + "since": "3.0.1", + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addGuestOs", "response": [ - { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the OS category", "name": "oscategoryid", @@ -61219,10 +62335,26 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -61241,6 +62373,13 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -61251,18 +62390,11 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {} + } ], "since": "3.0.0" }, @@ -61281,27 +62413,27 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.4.0" @@ -61311,6 +62443,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,32 +62463,25 @@ "name": "base64image", "required": true, "type": "string" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the 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", @@ -61367,18 +62499,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "configureSrxFirewall", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -61389,162 +62513,161 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "configureSrxFirewall", + "required": true, + "type": "uuid" } ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, - {}, { - "description": "state of the network", - "name": "state", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "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": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "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 ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "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": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the network's netmask", - "name": "netmask", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -61553,48 +62676,28 @@ "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": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { @@ -61603,160 +62706,104 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, - {}, { - "description": "The external id of the network", - "name": "externalid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the owner of the network", - "name": "account", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "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", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability value", + "name": "value", + "type": "string" }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", @@ -61769,31 +62816,19 @@ "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", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -61806,19 +62841,156 @@ ], "type": "list" }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, { "description": "network offering id the network is created from", "name": "networkofferingid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 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 the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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", "type": "string" } ] @@ -61847,27 +63019,15 @@ "related": "listKubernetesSupportedVersions", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" - }, - { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, - {}, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", "name": "mincpunumber", @@ -61878,14 +63038,25 @@ "name": "supportsautoscaling", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { @@ -61894,23 +63065,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { @@ -61930,14 +63102,6 @@ "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, @@ -61945,191 +63109,365 @@ "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" + }, + { + "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "length": 255, + "name": "forced", + "required": false, + "since": "4.15.1", + "type": "boolean" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "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 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 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": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "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": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + {}, + { + "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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "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 name of the virtual machine", + "name": "group", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "set" @@ -62139,19 +63477,14 @@ "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", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -62160,22 +63493,94 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -62184,8 +63589,8 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -62194,9 +63599,41 @@ "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" + } + ], + "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 ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -62208,23 +63645,23 @@ "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" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -62233,18 +63670,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -62260,184 +63697,169 @@ "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": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the description of the security group", "name": "description", "type": "string" }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the 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 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", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "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": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async 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 speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the 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", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "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 netmask of the nic", - "name": "netmask", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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 traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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" }, { @@ -62445,462 +63867,285 @@ "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "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 created", - "name": "created", - "type": "date" - }, - { - "description": "the read (io) of disk on the vm", + "description": "the read (IO) of disk on the VM", "name": "diskioread", "type": "long" }, { - "description": "the target memory in vm", + "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "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 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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - {}, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "true if 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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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 read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "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 project name of the vm", + "name": "project", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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 name of the disk offering of the virtual machine", + "name": "diskofferingname", + "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 group name of the virtual machine", - "name": "group", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + } + ] + }, + { + "description": "Creates a guest network IPv6 prefix.", + "isasync": true, + "name": "createGuestNetworkIpv6Prefix", + "params": [ + { + "description": "The /56 or higher IPv6 CIDR for network prefix.", + "length": 255, + "name": "prefix", + "required": true, "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": "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": "UUID of zone to which the IPv6 prefix belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listGuestNetworkIpv6Prefixes", + "response": [ + {}, + { + "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": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" } - ] + ], + "since": "4.17.0.0" }, { "description": " delete a Palo Alto firewall device", @@ -62923,22 +64168,22 @@ "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -62956,11 +64201,7 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -62972,12 +64213,16 @@ "type": "string" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -63009,13 +64254,12 @@ ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "Deployment Planner name", "name": "name", @@ -63025,7 +64269,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -63034,17 +64279,18 @@ "name": "createRole", "params": [ { - "description": "Creates a role with this unique name", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "The description of the role", + "description": "Creates a role with this unique name", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -63055,32 +64301,26 @@ "type": "string" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "The description of the role", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "description", "required": false, - "type": "uuid" + "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": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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", @@ -63092,16 +64332,21 @@ "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the type of the role", "name": "type", "type": "string" - } + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + {} ], "since": "4.9.0" }, @@ -63131,6 +64376,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -63140,8 +64386,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -63153,167 +64398,213 @@ "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", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "events available for the host", - "name": "events", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum 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 admin that annotated this host", - "name": "username", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the host version", + "name": "version", "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the 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 after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "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", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "true if local storage is active, false otherwise", "name": "islocalstorageactive", "type": "boolean" }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, { "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -63321,205 +64612,159 @@ "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": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "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 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 CPU speed of the host", - "name": "cpuspeed", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, { "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": "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", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the host version", - "name": "version", + "description": "the Zone name of the host", + "name": "zonename", "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 ID of the host", - "name": "id", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" } ] }, @@ -63538,25 +64783,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": "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" }, {} ] @@ -63576,23 +64821,23 @@ ], "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": "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,48 +64846,57 @@ "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": "string" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "the name of the volume/template", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "Upload volume/template for the project", + "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": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, "type": "uuid" }, { - "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": "Image store uuid", + "description": "Upload volume/template for the project", "length": 255, - "name": "imagestoreuuid", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "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.", @@ -63652,59 +64906,50 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Image store uuid", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "imagestoreuuid", "required": false, - "type": "uuid" - }, - { - "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" + "type": "string" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "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": "signature to be sent in the POST request.", "name": "signature", "type": "string" }, + {}, { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, { "description": "POST url to upload the file to", "name": "postURL", "type": "url" }, - {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "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" } ], @@ -63716,34 +64961,33 @@ "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": "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": false, "type": "integer" }, { - "description": "the frequency at which the conditions have to be evaluated", + "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": "interval", + "name": "maxmembers", "required": false, "type": "integer" }, { - "description": "list of scaleup autoscale policies", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the autoscale group", + "description": "the frequency at which the conditions have to be evaluated", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "name": "interval", + "required": false, + "type": "integer" }, { "description": "list of scaledown autoscale policies", @@ -63754,12 +64998,12 @@ "type": "list" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "customid", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { "description": "an optional field, whether to the display the group to the end user or not", @@ -63770,24 +65014,25 @@ "type": "boolean" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the ID of the autoscale group", "length": 255, - "name": "minmembers", - "required": false, - "type": "integer" + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" } ], "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "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.", @@ -63795,49 +65040,38 @@ "type": "int" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the autoscale vm group ID", + "name": "id", "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 project id vm profile", - "name": "projectid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { @@ -63845,26 +65079,37 @@ "name": "domain", "type": "string" }, + {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "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": "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "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" } ] }, @@ -63874,20 +65119,20 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the template of the auto deployed virtual machine", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "autoscaleuserid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "the ID of the autoscale vm profile", + "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": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the profile to the end user or not", @@ -63904,14 +65149,6 @@ "required": false, "type": "map" }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" - }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, @@ -63920,45 +65157,38 @@ "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" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" } ], "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "response": [ { - "description": "the 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 template to be used while deploying a virtual machine", - "name": "templateid", + "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 availability zone to be used while deploying a virtual machine", "name": "zoneid", "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" }, {}, @@ -63968,47 +65198,62 @@ "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", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, + {}, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, - {} + { + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" + }, + { + "description": "the account owning the instance group", + "name": "account", + "type": "string" + } ] }, { @@ -64028,90 +65273,90 @@ "related": "listAutoScaleVmGroups", "response": [ { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "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 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", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "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", + "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 vm group ID", - "name": "id", - "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 account owning the instance group", - "name": "account", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "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 autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, - {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" } ] @@ -64131,28 +65376,28 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -64161,21 +65406,28 @@ "name": "listVirtualMachines", "params": [ { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list by network id", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the security group ID", "length": 255, @@ -64186,96 +65438,97 @@ "type": "uuid" }, { - "description": "list objects by project", + "description": "list vms by iso", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by affinity group", "length": 255, - "name": "forvirtualnetwork", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the group ID", + "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": "list by the service offering", "length": 255, - "name": "showicon", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "page", + "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, - "type": "integer" + "since": "4.4", + "type": "list" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "haenable", + "name": "isrecursive", "required": false, - "since": "4.15", "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)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 only resources belonging to the domain specified", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "type": "uuid" }, { - "description": "list vms by vpc", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "list vms by ssh keypair name", + "description": "list vms by template", "length": 255, - "name": "keypair", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by network id", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the availability zone ID", + "description": "the target hypervisor for the template", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -64285,11 +65538,11 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "isrecursive", + "name": "keypair", "required": false, - "type": "boolean" + "type": "string" }, { "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", @@ -64299,72 +65552,59 @@ "type": "string" }, { - "description": "list vms by template", + "description": "", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list vms by iso", + "description": "the group ID", "length": 255, - "name": "isoid", + "name": "groupid", + "related": "createInstanceGroup", "required": false, "type": "uuid" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "the cluster ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.16.0", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "details", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the host ID", "length": 255, - "name": "tags", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "the availability zone ID", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the host ID", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "haenable", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { "description": "the pod ID", @@ -64375,37 +65615,35 @@ "type": "uuid" }, { - "description": "list by the service offering", + "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": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "accumulate", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the host ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "listDomainChildren,listDomains", "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, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the pod ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the virtual machine", @@ -64416,88 +65654,66 @@ "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "", + "description": "the cluster ID", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "name", "required": false, - "since": "4.4", - "type": "list" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "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": "listall", + "name": "details", "required": false, - "type": "boolean" + "type": "list" } ], "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": "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the 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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -64506,229 +65722,200 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "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 project ID of the affinity group", - "name": "projectid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the affinity group", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 type of the affinity group", + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "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 ip address of the nic", + "name": "ipaddress", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "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", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "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", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "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", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "device type of the root volume", + "name": "rootdevicetype", "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -64737,28 +65924,28 @@ "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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], @@ -64770,29 +65957,28 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "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" }, { @@ -64801,217 +65987,264 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the 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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "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 name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -65020,56 +66253,63 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -65078,18 +66318,28 @@ "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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -65098,21 +66348,73 @@ "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -65120,33 +66422,38 @@ "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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" }, { @@ -65155,253 +66462,278 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "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 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 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 ID of the security group", + "name": "id", "type": "string" }, { "description": "the description of the security group", "name": "description", "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "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", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "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 (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" } ] }, + { + "description": "Lists guest network IPv6 prefixes", + "isasync": false, + "name": "listGuestNetworkIpv6Prefixes", + "params": [ + { + "description": "UUID of the IPv6 prefix.", + "length": 255, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "UUID of zone to which the IPv6 prefix belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" + }, + {} + ], + "since": "4.17.0" + }, { "description": "Updates the information about Guest OS to Hypervisor specific name mapping", "isasync": true, @@ -65425,20 +66757,29 @@ ], "related": "", "response": [ + { + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "version of the hypervisor for mapping", "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the ID of the Guest OS type", "name": "ostypeid", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { @@ -65447,31 +66788,22 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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", - "type": "string" - } + {} ], "since": "4.4.0" }, @@ -65481,25 +66813,19 @@ "name": "listDiskOfferings", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.17", "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": "ID of the disk offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -65513,30 +66839,40 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "name of the disk offering", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "keyword", + "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", @@ -65546,124 +66882,128 @@ "required": false, "since": "4.13", "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", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "createDiskOffering", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "true if disk offering uses custom size, false otherwise", + "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": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the name of the disk offering", + "name": "name", "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "name": "cacheMode", "type": "string" }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, { "description": "true if disk offering uses custom iops, false otherwise", "name": "iscustomizediops", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, - {}, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, + { + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "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": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "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 storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { @@ -65672,61 +67012,76 @@ "type": "date" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "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 disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "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 vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "name": "hypervisorsnapshotreserve", "type": "integer" - } + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + {} ] }, { @@ -65735,19 +67090,27 @@ "name": "updateHostPassword", "params": [ { - "description": "the host ID", + "description": "the username for the host/cluster", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the new password for the host/cluster", + "description": "the host ID", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" }, { "description": "if the password should also be updated on the hosts", @@ -65757,43 +67120,35 @@ "type": "boolean" }, { - "description": "the username for the host/cluster", + "description": "the new password for the host/cluster", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" - }, - { - "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" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {} ] }, @@ -65802,28 +67157,6 @@ "isasync": true, "name": "createPortableIpRange", "params": [ - { - "description": "the netmask of the portable IP range", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - }, - { - "description": "Id of the Region", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" - }, - { - "description": "the ending IP address in the portable IP range", - "length": 255, - "name": "endip", - "required": true, - "type": "string" - }, { "description": "VLAN id, if not specified defaulted to untagged", "length": 255, @@ -65844,39 +67177,39 @@ "name": "startip", "required": true, "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the netmask of the portable IP range", + "length": 255, "name": "netmask", + "required": true, "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - { - "description": "Region Id in which portable ip range is provisioned", + "description": "Id of the Region", + "length": 255, "name": "regionid", + "related": "addRegion,listRegions", + "required": true, "type": "integer" }, + { + "description": "the ending IP address in the portable IP range", + "length": 255, + "name": "endip", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { "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": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -65885,29 +67218,29 @@ "type": "date" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the account ID the portable IP address is associated with", @@ -65920,26 +67253,38 @@ "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" } ], "type": "list" }, + { + "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 start ip of the portable IP range", + "name": "startip", + "type": "string" + }, { "description": "portable IP range ID", "name": "id", "type": "string" }, + {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -65947,10 +67292,20 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, { "description": "the end ip of the portable IP range", "name": "endip", "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" } ], "since": "4.2.0" @@ -65968,24 +67323,16 @@ "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "whether this cluster is managed by cloudstack", + "description": "hypervisor type of the cluster", "length": 255, - "name": "managedstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "hypervisor", + "name": "managedstate", "required": false, "type": "string" }, @@ -66002,10 +67349,69 @@ "name": "allocationstate", "required": false, "type": "string" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" } ], "related": "addCluster", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, { "description": "the capacity of the Cluster", "name": "capacity", @@ -66016,19 +67422,9 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity currently in use", @@ -66041,14 +67437,14 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "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 ID", @@ -66056,9 +67452,9 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { "description": "the Cluster ID", @@ -66066,78 +67462,42 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", "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", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, {}, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, { "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { @@ -66146,18 +67506,13 @@ "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "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": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" } ] @@ -66177,13 +67532,18 @@ } ], "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", @@ -66193,11 +67553,6 @@ "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" } ] }, @@ -66207,18 +67562,18 @@ "name": "upgradeKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes version for upgrade", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": true, "type": "uuid" } @@ -66226,68 +67581,78 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "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", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "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 control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { @@ -66296,110 +67661,100 @@ "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "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", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the Kubernetes cluster", + "name": "name", "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": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "keypair details", + "name": "keypair", "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", - "type": "string" - }, { "description": "the project id of the Kubernetes cluster", "name": "projectid", "type": "string" }, { - "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 ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" } ] @@ -66409,6 +67764,14 @@ "isasync": false, "name": "listUcsProfiles", "params": [ + { + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "addUcsManager", + "required": true, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -66423,14 +67786,6 @@ "required": false, "type": "integer" }, - { - "description": "the id for the ucs manager", - "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -66441,6 +67796,11 @@ ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "ucs profile dn", "name": "ucsdn", @@ -66452,11 +67812,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -66465,20 +67820,6 @@ "isasync": false, "name": "listStorageProviders", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the type of storage provider: either primary or image", "length": 255, @@ -66492,17 +67833,25 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66517,7 +67866,13 @@ "description": "the type of the storage provider: primary or image provider", "name": "type", "type": "string" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -66536,9 +67891,15 @@ ], "related": "registerUserKeys", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { @@ -66547,15 +67908,9 @@ "type": "integer" }, {}, - {}, { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -66573,6 +67928,14 @@ "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", "length": 255, @@ -66586,41 +67949,40 @@ "name": "gslblbmethod", "required": false, "type": "string" - }, - { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, + {}, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "global load balancer rule ID", + "name": "id", "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": "GSLB service type", - "name": "gslbservicetype", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { @@ -66628,23 +67990,8 @@ "name": "loadbalancerrule", "response": [ { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -66652,64 +67999,19 @@ "name": "algorithm", "type": "string" }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, { "description": "the id of the zone the rule belongs to", "name": "zoneid", "type": "string" }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, { "description": "the public port", "name": "publicport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "is 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 project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -66722,106 +68024,164 @@ "name": "protocol", "type": "string" }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the 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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" } ], "type": "list" }, { - "description": "name of the global load balancer rule", - "name": "name", + "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 description of the global load balancer rule", + "name": "description", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { @@ -66830,13 +68190,8 @@ "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", + "description": "Region Id in which global load balancer is created", + "name": "regionid", "type": "integer" } ] @@ -66854,6 +68209,13 @@ "required": true, "type": "uuid" }, + { + "description": "Threshold value.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" + }, { "description": "the domain ID of the account.", "length": 255, @@ -66862,30 +68224,38 @@ "required": false, "type": "uuid" }, + { + "description": "Relational Operator to be used with threshold.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" + }, { "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" }, { - "description": "Threshold value.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "description": "the owner of the Condition.", + "name": "account", + "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "length": 255, - "name": "relationaloperator", - "required": true, + "description": "the id of the Condition", + "name": "id", "type": "string" - } - ], - "related": "", - "response": [ + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -66896,47 +68266,27 @@ "name": "project", "type": "string" }, - { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" - }, - {}, - {}, - { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, - { - "description": "Details of the Counter.", - "name": "counter", - "type": "list" - }, - { - "description": "the domain id of the Condition owner", - "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 Condition", - "name": "id", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, + {}, { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "list" }, { "description": "zone id of counter", @@ -66944,8 +68294,13 @@ "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the domain name of the owner.", + "name": "domain", "type": "string" } ] @@ -66956,40 +68311,40 @@ "name": "listProjects", "params": [ { - "description": "", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list projects by project ID", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list projects by display text", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "displaytext", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list projects by project ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", @@ -67005,13 +68360,6 @@ "required": false, "type": "string" }, - { - "description": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -67020,12 +68368,11 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List projects by username", @@ -67042,71 +68389,50 @@ "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "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 projects by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" + }, + { + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" } ], "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "response": [ + {}, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the name of the project", - "name": "name", + "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 list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -67125,106 +68451,142 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "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 project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "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", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "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 primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "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": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, { "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "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": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { @@ -67233,19 +68595,14 @@ "type": "string" }, { - "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", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "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", @@ -67253,50 +68610,43 @@ "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 total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, - {}, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "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", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { @@ -67305,59 +68655,64 @@ "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the 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 total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" } ], "since": "3.0.0" @@ -67368,51 +68723,37 @@ "name": "createAccount", "params": [ { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, - "type": "string" - }, - { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "account", + "name": "userid", "required": false, "type": "string" }, - { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, - "type": "string" - }, { "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, "name": "accounttype", "required": false, - "type": "short" + "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.", + "description": "Unique username.", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Network domain for the account's networks", "length": 255, - "name": "userid", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "Unique username.", + "description": "lastname", "length": 255, - "name": "username", + "name": "lastname", "required": true, "type": "string" }, @@ -67424,6 +68765,13 @@ "required": false, "type": "uuid" }, + { + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, + "type": "string" + }, { "description": "Creates the account under the specified role.", "length": 255, @@ -67433,31 +68781,38 @@ "type": "uuid" }, { - "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": "email", + "description": "firstname", "length": 255, - "name": "email", + "name": "firstname", "required": true, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "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": "accountid", + "name": "account", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "email", "length": 255, - "name": "timezone", - "required": false, + "name": "email", + "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.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { @@ -67471,73 +68826,48 @@ "related": "enableAccount,listAccounts,listAccounts", "response": [ { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "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 total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "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 UUID of the latest async job acting on this object", + "name": "jobid", "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", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the account", - "name": "name", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { @@ -67546,74 +68876,110 @@ "type": "date" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, { "description": "the total primary storage space (in GiB) the account can own", "name": "primarystoragelimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "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": "the name of the account", + "name": "name", + "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 available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { "description": "account type (admin, domain-admin, user)", "name": "accounttype", - "type": "short" + "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 snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { "description": "the total number of network traffic bytes sent", @@ -67621,18 +68987,18 @@ "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { @@ -67640,202 +69006,188 @@ "name": "vpcavailable", "type": "string" }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "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) owned by account", "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "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", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the role", + "name": "rolename", "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", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "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 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 timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the api key of the user", + "name": "apikey", "type": "string" } ], "type": "list" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { "description": "the list of 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 projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the network domain", @@ -67843,39 +69195,38 @@ "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "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 total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, - {}, { - "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": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "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" }, { @@ -67883,11 +69234,15 @@ "name": "memorytotal", "type": "long" }, - {}, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" } ] }, @@ -67908,36 +69263,51 @@ "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", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { "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 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 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 id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -67945,13 +69315,18 @@ "name": "startport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -67960,28 +69335,28 @@ "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": "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": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -67990,256 +69365,241 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "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" } ], "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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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 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 ID of the security group", - "name": "id", - "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", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the project id of the group", @@ -68247,27 +69607,51 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -68276,13 +69660,13 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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": "publicip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -68291,9 +69675,14 @@ "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { "description": "the ID of the service offering of the virtual machine", @@ -68301,49 +69690,48 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "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 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": "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": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -68352,28 +69740,29 @@ "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { @@ -68382,261 +69771,215 @@ "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "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 id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "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": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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": "publicipid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 name of the affinity group", - "name": "name", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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", - "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -68645,9 +69988,9 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the IPv6 address of network", @@ -68655,13 +69998,23 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -68670,34 +70023,34 @@ "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the 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 ID of the nic", + "name": "id", + "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "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": "true if nic is default, false otherwise", @@ -68705,158 +70058,160 @@ "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "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": "publicipid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, + {}, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" } ], "since": "4.2.0" @@ -68867,11 +70222,11 @@ "name": "listHostTags", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -68881,42 +70236,42 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "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 host ID of the host tag", + "name": "hostid", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the name of the host tag", "name": "name", "type": "string" }, - {}, - { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -68924,13 +70279,6 @@ "isasync": true, "name": "addGuestOs", "params": [ - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": true, - "type": "map" - }, { "description": "ID of Guest OS category", "length": 255, @@ -68952,16 +70300,17 @@ "name": "osdisplayname", "required": true, "type": "string" + }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": true, + "type": "map" } ], "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", @@ -68972,11 +70321,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, { "description": "the name/description of the OS type", "name": "description", @@ -68987,7 +70331,18 @@ "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" - } + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -68996,6 +70351,13 @@ "isasync": false, "name": "addAnnotation", "params": [ + { + "description": "the id of the entity to annotate", + "length": 255, + "name": "entityid", + "required": false, + "type": "string" + }, { "description": "the annotation is visible for admins only", "length": 255, @@ -69005,9 +70367,9 @@ "type": "boolean" }, { - "description": "the id of the entity to annotate", + "description": "the annotation text", "length": 255, - "name": "entityid", + "name": "annotation", "required": false, "type": "string" }, @@ -69017,40 +70379,44 @@ "name": "entitytype", "required": false, "type": "string" - }, - { - "description": "the annotation text", - "length": 255, - "name": "annotation", - "required": false, - "type": "string" } ], "related": "removeAnnotation,updateAnnotationVisibility", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the (uu)id of the entitiy to which this annotation pertains", "name": "entityid", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { @@ -69059,8 +70425,8 @@ "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" }, { @@ -69070,26 +70436,15 @@ }, {}, { - "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 username of the user that entered the annotation", - "name": "username", + "description": "the name of the entitiy to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.11" }, @@ -69108,28 +70463,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,18 +70494,18 @@ "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": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "checksum", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "the name of the ISO", "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "true if you want this ISO to be featured", @@ -69160,12 +70515,11 @@ "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the URL to where the ISO is currently being hosted", @@ -69175,32 +70529,12 @@ "type": "string" }, { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", - "length": 255, - "name": "directdownload", - "required": false, - "type": "boolean" - }, - { - "description": "true if password reset feature is supported; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "ispublic", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the zone you wish to register the ISO to.", @@ -69210,6 +70544,13 @@ "required": true, "type": "uuid" }, + { + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, { "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, @@ -69232,14 +70573,6 @@ "required": false, "type": "string" }, - { - "description": "Register ISO for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, { "description": "the display text of the ISO. This is usually used for display purposes.", "length": 4096, @@ -69247,87 +70580,85 @@ "required": true, "type": "string" }, - { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, { "description": "Image store UUID", "length": 255, "name": "imagestoreuuid", "required": false, "type": "string" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Register ISO for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, + {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "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": "VMware only: additional key/value details tied with deploy-as-is template", @@ -69335,130 +70666,135 @@ "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, { "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 template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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 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": "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" } ], "type": "set" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -69467,106 +70803,125 @@ "type": "boolean" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, - {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "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", - "type": "boolean" + "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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" } ] }, @@ -69584,18 +70939,18 @@ "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.", + "description": "", "length": 255, - "name": "hostname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the Physical Network ID", @@ -69606,18 +70961,18 @@ "type": "uuid" }, { - "description": "", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "page", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addCiscoAsa1000vResource", @@ -69630,14 +70985,14 @@ {}, {}, {}, + {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, - {}, {} ] }, @@ -69647,21 +71002,13 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "the ID of the template for the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, - { - "description": "The network this ip address should be associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -69671,35 +71018,33 @@ "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" + }, + { + "description": "The network this ip address should be associated to.", + "length": 255, + "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": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { "description": "the management IP address of the external load balancer", @@ -69707,65 +71052,75 @@ "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, + {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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", + "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": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -69785,18 +71140,12 @@ ], "related": "", "response": [ + {}, { - "description": "the name of the volume", - "name": "name", + "description": "the id of the volume", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "syncronization", "name": "sync", @@ -69812,59 +71161,26 @@ "name": "jobid", "type": "string" }, - { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" - }, { "description": "compression", "name": "compression", "type": "string" }, - { - "description": "the id of the volume", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", - "params": [ - { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the volume", + "name": "name", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "graceallowed", + "name": "graceallowed", + "type": "string" } ] }, @@ -69874,16 +71190,9 @@ "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "type of pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", + "name": "tftpdir", "required": true, "type": "string" }, @@ -69896,45 +71205,58 @@ "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "type of pxe device", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "pxeservertype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, { - "description": "URL of the external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", "required": true, "type": "string" } ], "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": "url", + "name": "url", "type": "string" }, { @@ -69942,50 +71264,68 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, { "description": "Tftp root directory of PXE server", "name": "tftpdir", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} ] }, { - "description": "Lists Nicira NVP devices", - "isasync": false, - "name": "listNiciraNvpDevices", + "description": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", "params": [ { - "description": "nicira nvp device ID", + "description": "Id of the portable ip range", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": false, + "name": "id", + "related": "", + "required": true, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "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": "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": "Lists Nicira NVP devices", + "isasync": false, + "name": "listNiciraNvpDevices", + "params": [ { "description": "List by keyword", "length": 255, @@ -70000,6 +71340,14 @@ "required": false, "type": "integer" }, + { + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": false, + "type": "uuid" + }, { "description": "the Physical Network ID", "length": 255, @@ -70007,59 +71355,66 @@ "related": "createPhysicalNetwork", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", - "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 Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this Nirica Nvp 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 controller Ip address", + "name": "hostname", + "type": "string" }, + {}, { - "description": "device name", - "name": "niciradevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "name of the provider", + "name": "provider", "type": "string" }, {} @@ -70071,25 +71426,18 @@ "name": "listAlerts", "params": [ { - "description": "the ID of the alert", - "length": 255, - "name": "id", - "related": "listAlerts", - "required": false, - "type": "uuid" - }, - { - "description": "list by alert type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list by alert name", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "4.3", "type": "string" }, { @@ -70099,6 +71447,14 @@ "required": false, "type": "integer" }, + { + "description": "the ID of the alert", + "length": 255, + "name": "id", + "related": "listAlerts", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -70107,11 +71463,10 @@ "type": "integer" }, { - "description": "list by alert name", + "description": "list by alert type", "length": 255, - "name": "name", + "name": "type", "required": false, - "since": "4.3", "type": "string" } ], @@ -70122,12 +71477,23 @@ "name": "sent", "type": "date" }, + {}, + {}, + { + "description": "the id of the alert", + "name": "id", + "type": "string" + }, + { + "description": "the name of the alert", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "description of the alert", "name": "description", @@ -70138,21 +71504,10 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the id of the alert", - "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", - "type": "string" } ] }, @@ -70162,64 +71517,116 @@ "name": "deployVirtualMachine", "params": [ { - "description": "the ipv6 address for default vm's network", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "ip6address", + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", "required": false, "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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": "size", + "name": "overridediskofferingid", + "related": "createDiskOffering", "required": false, - "type": "long" + "since": "4.17", + "type": "uuid" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "dynamicscalingenabled", + "name": "details", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "datadiskofferinglist", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.11", + "since": "4.13", + "type": "uuid" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "group", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", "required": false, "type": "string" }, { - "description": "host name for the virtual machine", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "name", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "rootdisksize", + "name": "displayname", "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": "the ip address for default vm's network", "length": 255, - "name": "customid", + "name": "ipaddress", "required": false, "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": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, { "description": "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, @@ -70228,27 +71635,28 @@ "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.", - "length": 1048576, - "name": "userdata", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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": "details", + "name": "boottype", "required": false, - "since": "4.3", - "type": "map" + "since": "4.14.0.0", + "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": "availability zone for the virtual machine", "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "used to specify the vApp properties.", @@ -70259,43 +71667,43 @@ "type": "map" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.12", - "type": "string" + "type": "list" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "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": "startvm", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "boolean" + "type": "list" }, { - "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": "host name for the virtual machine", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "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": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "datadiskofferinglist", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.11", + "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": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "dynamicscalingenabled", "required": false, - "type": "list" + "since": "4.16", + "type": "boolean" }, { "description": "an optional field, whether to the display the vm to the end user or not.", @@ -70306,41 +71714,40 @@ "type": "boolean" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "hypervisor", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "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": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "securitygroupnames", + "related": "createSecurityGroup", + "required": false, + "type": "list" }, { - "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": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "boottype", + "name": "keypair", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "description": "the ip address for default vm's network", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, { @@ -70351,539 +71758,332 @@ "type": "map" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "startvm", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "securitygroupids", + "related": "createSecurityGroup", "required": false, "type": "list" }, { - "description": "the ID of the template for the virtual machine", + "description": "Deploy vm for the project", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware, as we honour what is defined in the template.", + "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": "bootmode", + "name": "rootdisksize", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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": "account", + "name": "diskofferingid", + "related": "createDiskOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", - "length": 255, - "name": "bootintosetup", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "string" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "keyboard", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "the mac address for default vm's network", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "macaddress", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "availability zone for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "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": "deploymentplanner", + "name": "bootmode", "required": false, - "since": "4.4", + "since": "4.14.0.0", "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "keyboard", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "Deploy vm for the project", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "deploymentplanner", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "customid", "required": false, - "type": "uuid" + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "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", + "description": "the list of resource tags associated", + "name": "tags", "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "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": "Guest vm Boot Mode", - "name": "bootmode", + "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 host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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 domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the 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 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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, - { - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -70891,33 +72091,33 @@ "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": "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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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" }, { @@ -70926,82 +72126,67 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -71010,13 +72195,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -71025,8 +72210,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -71038,13 +72223,23 @@ "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "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" }, { @@ -71057,185 +72252,289 @@ "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 starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, - {}, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - {}, - {}, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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": "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": "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the 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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "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", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -71244,43 +72543,23 @@ "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 name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -71289,53 +72568,13 @@ "type": "resourceiconresponse" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -71343,33 +72582,28 @@ "name": "affinitygroup", "response": [ { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -71378,131 +72612,268 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "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 project ID of the affinity group", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "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": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "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": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "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 internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - } - ] - }, - { - "description": "Upgrades router to use newer template", - "isasync": false, - "name": "upgradeRouterTemplate", - "params": [ + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, { - "description": "upgrades all routers within the specified pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "upgrades all routers owned by the specified domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "upgrades all routers within the specified zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "upgrades router with the specified Id", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", - "required": false, - "type": "uuid" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "upgrades all routers owned by the specified account", - "length": 255, - "name": "account", - "required": false, + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Upgrades router to use newer template", + "isasync": false, + "name": "upgradeRouterTemplate", + "params": [ + { + "description": "upgrades all routers within the specified cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers owned by the specified account", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "upgrades all routers owned by the specified domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades router with the specified Id", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + } ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -71513,7 +72884,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -71525,47 +72897,58 @@ "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": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, + {}, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "the CPU number of the host", @@ -71573,24 +72956,19 @@ "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", @@ -71598,23 +72976,43 @@ "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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 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 host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "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": "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { @@ -71622,68 +73020,81 @@ "name": "lastannotated", "type": "date" }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "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 management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { "description": "the cluster type of the cluster that host belongs to", "name": "clustertype", "type": "string" }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -71693,43 +73104,43 @@ "name": "vgpu", "response": [ { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "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" } ], @@ -71744,28 +73155,28 @@ "type": "list" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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 Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -71773,124 +73184,85 @@ "name": "hasenoughcapacity", "type": "boolean" }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "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": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "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", + "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 used", + "name": "memoryused", + "type": "long" }, + {}, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" } ] @@ -71900,14 +73272,6 @@ "isasync": false, "name": "listVlanIpRanges", "params": [ - { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,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.", "length": 255, @@ -71917,57 +73281,57 @@ "type": "uuid" }, { - "description": "physical network id of the VLAN IP range", + "description": "project who will own the VLAN", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "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 VLAN IP range", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "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": "network id of the VLAN IP range", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "true if VLAN is of Virtual type, false if Direct", @@ -71991,35 +73355,38 @@ "type": "integer" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the VLAN IP range", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" } ], "related": "updateVlanIpRange,dedicatePublicIpRange", "response": [ - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, { "description": "the domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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 gateway of the VLAN IP range", @@ -72027,105 +73394,115 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, + {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "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 domain ID of the VLAN IP range", - "name": "domainid", + "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 ID of the VLAN IP range", + "name": "id", + "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 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": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, - {}, { "description": "the start ip of the VLAN IP range", "name": "startip", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" } ] @@ -72136,39 +73513,39 @@ "name": "updateZone", "params": [ { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "allocationstate", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the Zone", + "description": "the dns search order list", "length": 255, - "name": "name", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "the guest CIDR address for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "guestcidraddress", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the second DNS for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "dns2", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the details for the Zone", "length": 255, - "name": "domain", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "the first DNS for the Zone", @@ -72178,46 +73555,54 @@ "type": "string" }, { - "description": "the details for the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "details", + "name": "guestcidraddress", "required": false, - "type": "map" + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "internaldns1", + "name": "dns2", "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "internaldns1", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "ip6dns2", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the ID of the Zone", "length": 255, - "name": "internaldns2", + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the dhcp Provider for the Zone", + "length": 255, + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the dns search order list", + "description": "the name of the Zone", "length": 255, - "name": "dnssearchorder", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { "description": "the first DNS for IPv6 network in the Zone", @@ -72227,27 +73612,19 @@ "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "ispublic", + "name": "allocationstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "dhcpprovider", + "name": "domain", "required": false, "type": "string" }, - { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "sort key of the zone, integer", "length": 255, @@ -72259,13 +73636,13 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { @@ -72274,13 +73651,23 @@ "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -72288,59 +73675,65 @@ "name": "name", "type": "string" }, + {}, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity name", + "name": "name", "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", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the Pod ID", @@ -72348,70 +73741,65 @@ "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "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": "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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -72420,43 +73808,47 @@ "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": "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" } ], "type": "set" }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, { "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", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -72464,8 +73856,8 @@ "type": "boolean" }, { - "description": "Zone description", - "name": "description", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { @@ -72474,41 +73866,26 @@ "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, - {}, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "Zone description", + "name": "description", "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" - } + {} ] }, { @@ -72524,6 +73901,14 @@ "required": true, "type": "uuid" }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, { "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, @@ -72537,98 +73922,90 @@ "name": "url", "required": false, "type": "string" - }, - { - "description": "the ID of the volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" } ], "related": "extractTemplate", "response": [ + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, {}, { "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", - "type": "string" - }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - }, { "description": "the time and date the object was created", "name": "created", "type": "date" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "type of the storage", + "name": "storagetype", + "type": "string" }, { "description": "the mode of extraction - upload or download", "name": "extractMode", "type": "string" }, - {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the extraction", + "name": "status", "type": "string" } ] @@ -72639,19 +74016,11 @@ "name": "listProjectAccounts", "params": [ { - "description": "list accounts of the project by project role id", - "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", - "required": false, - "type": "uuid" - }, - { - "description": "list accounts of the project by role", + "description": "", "length": 255, - "name": "role", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the project", @@ -72661,6 +74030,14 @@ "required": true, "type": "uuid" }, + { + "description": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -72671,88 +74048,38 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "list accounts of the project by project role id", "length": 255, - "name": "page", + "name": "projectroleid", + "related": "updateProjectRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list accounts of the project by account name", + "description": "list accounts of the project by role", "length": 255, - "name": "account", + "name": "role", "required": false, "type": "string" }, { - "description": "list invitation by user ID", + "description": "list accounts of the project by account name", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "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 total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { @@ -72761,56 +74088,34 @@ "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 total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of 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 number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, - {}, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { "description": "the total number of cpu cores the project can own", @@ -72818,107 +74123,42 @@ "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { "description": "the total primary storage space (in GiB) available to be used for this project", "name": "primarystorageavailable", "type": "string" }, - { - "description": "the total number of virtual machines 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 public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, { "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "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 vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ - { - "description": "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -72927,13 +74167,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -72945,44 +74185,66 @@ "description": "tag key name", "name": "key", "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { "description": "the total number of templates which can be created by this project", "name": "templatelimit", "type": "string" }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "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", - "type": "long" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { "description": "the total secondary storage space (in GiB) the project can own", @@ -72990,103 +74252,127 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "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" - } - ], - "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": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "Password of the external load balancer appliance.", - "length": 255, - "name": "password", - "required": true, + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "Username of the external load balancer appliance.", - "length": 255, - "name": "username", - "required": true, + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "URL of the external load balancer appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the ID of the external load balancer", - "name": "id", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the username that's used to log in to the external load balancer", - "name": "username", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the private interface of the external load balancer", - "name": "privateinterface", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the number of times to retry requests to the external load balancer", - "name": "numretries", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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 secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the zone ID of the external load balancer", - "name": "zoneid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the public interface of the external load balancer", - "name": "publicinterface", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, - {}, { - "description": "the ID of the network device", - "name": "id", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" } - ] + ], + "since": "3.0.0" }, { "description": "Updates an existing autoscale policy.", @@ -73094,24 +74380,16 @@ "name": "updateAutoScalePolicy", "params": [ { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "description": "the duration for which the conditions have to be true before action is taken", "length": 255, - "name": "quiettime", + "name": "duration", "required": false, "type": "integer" }, { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" - }, - { - "description": "the duration for which the conditions have to be true before action is taken", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "duration", + "name": "quiettime", "required": false, "type": "integer" }, @@ -73122,23 +74400,26 @@ "related": "", "required": false, "type": "list" + }, + { + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "uuid" } ], "related": "listAutoScalePolicies", "response": [ - { - "description": "the domain name of the autoscale policy", - "name": "domain", - "type": "string" - }, { "description": "the project id autoscale policy", "name": "projectid", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, {}, @@ -73147,17 +74428,17 @@ "name": "action", "type": "string" }, + {}, { - "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 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", @@ -73169,8 +74450,13 @@ "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 domain name of the autoscale policy", + "name": "domain", "type": "string" }, { @@ -73179,14 +74465,14 @@ "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the autoscale policy ID", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -73196,78 +74482,74 @@ "name": "createDiskOffering", "params": [ { - "description": "length (in seconds) of the burst", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "iopswriterate", "required": false, "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "displayoffering", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "iopsreadrate", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "cachemode", + "name": "disksize", "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": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "min iops of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "miniops", "required": false, "type": "long" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", "required": false, "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "whether disk offering iops is custom or not", "length": 255, - "name": "iopsreadratemaxlength", + "name": "customizediops", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "byteswriterate", "required": false, - "type": "list" + "type": "long" }, { "description": "details to specify disk offering parameters", @@ -73278,52 +74560,40 @@ "type": "map" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "type": "long" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, - "type": "string" - }, - { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "storagetype", + "name": "cachemode", "required": false, + "since": "4.14", "type": "string" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "max iops of the disk offering", "length": 255, - "name": "disksize", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "name of the disk offering", - "length": 255, - "name": "name", + "description": "alternate display text of the disk offering", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemax", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "whether disk offering size is custom or not", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "length": 255, - "name": "customized", + "name": "disksizestrictness", "required": false, + "since": "4.17", "type": "boolean" }, { @@ -73336,67 +74606,70 @@ "type": "list" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "min iops of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "miniops", + "name": "displayoffering", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "max iops of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "maxiops", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "bytesreadratemaxlength", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "long" + "type": "list" }, { - "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": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadrate", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "whether disk offering iops is custom or not", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "customizediops", + "name": "storagetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "iopsreadratemax", "required": false, - "type": "integer" + "type": "long" }, { "description": "length (in seconds) of the burst", @@ -73404,50 +74677,66 @@ "name": "byteswriteratemaxlength", "required": false, "type": "long" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "whether disk offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "type": "boolean" + }, + { + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" } ], "related": "", "response": [ { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, + {}, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { "description": "true if disk offering uses custom size, false otherwise", @@ -73455,84 +74744,84 @@ "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "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": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, - {}, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "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 name of the disk offering", + "name": "name", "type": "string" }, { @@ -73541,49 +74830,59 @@ "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the min iops of the disk offering", + "name": "miniops", + "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": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "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", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" } ] }, @@ -73593,48 +74892,50 @@ "name": "listVolumes", "params": [ { - "description": "the cluster id the disk volume belongs to", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "list volumes on specified host", "length": 255, - "name": "state", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "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 IDs of the volumes, mutually exclusive with id", + "description": "list volumes by disk offering", "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.9", - "type": "list" + "since": "4.4", + "type": "uuid" }, { - "description": "the type of disk volume", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "type", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "string" }, { @@ -73646,94 +74947,87 @@ "type": "uuid" }, { - "description": "list objects by project", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "displayvolume", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list volumes on specified host", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "name", + "name": "ids", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the type of disk volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "type", "required": false, - "since": "4.3", "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the ID of the virtual machine", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "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.", + "description": "the ID of the availability zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the pod id the disk volume belongs to", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "the ID of the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "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": "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" }, @@ -73746,18 +75040,23 @@ "type": "uuid" }, { - "description": "list volumes by disk offering", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the disk volume", "length": 255, - "name": "keyword", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" } @@ -73765,28 +75064,33 @@ "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "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": "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" }, { @@ -73795,13 +75099,18 @@ "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { @@ -73810,129 +75119,89 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "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": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "pod id of the volume", + "name": "podid", "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", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - { - "description": "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { "description": "name of the primary storage hosting the disk volume", @@ -73940,99 +75209,90 @@ "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": "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": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the status of the volume", + "name": "status", "type": "string" }, + {}, + {}, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - {}, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the path of the volume", + "name": "path", "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": "the status of the volume", - "name": "status", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -74040,113 +75300,157 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "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": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "size of the disk volume", - "name": "size", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { "description": "the chain info of the volume", "name": "chaininfo", "type": "string" }, - {}, { - "description": "the path of the volume", - "name": "path", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { "description": "the display text of the service offering for root disk", "name": "serviceofferingdisplaytext", "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" } ] }, @@ -74156,27 +75460,25 @@ "name": "createLBHealthCheckPolicy", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "fordisplay", + "name": "healthythreshold", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "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": "HTTP ping path", "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "name": "pingpath", + "required": false, + "type": "string" }, { "description": "the description of the load balancer health check policy", @@ -74186,50 +75488,66 @@ "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "unhealthythreshold", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "HTTP ping path", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "pingpath", + "name": "intervaltime", "required": false, - "type": "string" + "type": "integer" }, { - "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" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "the ID of the load balancer rule", "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "listLBHealthCheckPolicies", "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 id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, {}, @@ -74243,9 +75561,9 @@ "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { "description": "Time to wait when receiving a response from the health check", @@ -74253,14 +75571,14 @@ "type": "int" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" }, { "description": "Amount of time between health checks", @@ -74268,13 +75586,13 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { @@ -74286,25 +75604,11 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - } + {} ], "since": "4.2.0" }, @@ -74325,47 +75629,20 @@ "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", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, - {}, { "description": "true if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the type of the role", "name": "roletype", @@ -74377,73 +75654,100 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "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 domain name of the user", "name": "domain", "type": "string" }, + {}, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, + {}, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "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 timezone user was created in", + "name": "timezone", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" } ] @@ -74455,6 +75759,12 @@ "params": [], "related": "", "response": [ + {}, + { + "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", @@ -74466,12 +75776,6 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the Cloudian Management Console base URL", - "name": "url", - "type": "string" - }, { "description": "the Cloudian connector enabled state", "name": "enabled", @@ -74486,19 +75790,20 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "List by keyword", + "description": "the ID of the load balancer rule", "length": 255, - "name": "keyword", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "lbruleid", - "related": "", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the health check policy", @@ -74510,19 +75815,18 @@ "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", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "", @@ -74534,28 +75838,18 @@ ], "related": "", "response": [ - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "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", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the state of the policy", + "name": "state", "type": "string" }, { @@ -74569,36 +75863,47 @@ "type": "boolean" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", "type": "int" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "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" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" } ], "type": "list" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { @@ -74606,23 +75911,22 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, { - "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" + } ], "since": "4.2.0" }, @@ -74631,20 +75935,6 @@ "isasync": false, "name": "createNetwork", "params": [ - { - "description": "account that will own the network", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, { "description": "Network ACL ID associated for the network", "length": 255, @@ -74654,49 +75944,41 @@ "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "ip6gateway", + "name": "routerip", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the physical network ID the network belongs to", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the VPC network belongs to", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the isolated private VLAN type for this network", + "description": "account that will own the network", "length": 255, - "name": "isolatedpvlantype", + "name": "account", "required": false, "type": "string" }, { - "description": "the network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "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", + "description": "an optional project for the network", "length": 255, - "name": "subdomainaccess", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "IPV6 address to be assigned to a router in a shared network", @@ -74707,48 +75989,47 @@ "type": "string" }, { - "description": "an optional project for the SSH key", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "hideipaddressusage", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "ID of the network in an external system.", "length": 255, - "name": "routerip", + "name": "externalid", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the name of the network", + "description": "the ID or VID of the network", "length": 255, - "name": "name", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "domain ID of the account owning a network", + "description": "the network offering ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "displaynetwork", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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 display text of the network", "length": 255, - "name": "acltype", - "required": false, + "name": "displaytext", + "required": true, "type": "string" }, { @@ -74759,18 +76040,19 @@ "type": "string" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "the VPC network belongs to", "length": 255, - "name": "endip", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the display text of the network", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "displaytext", - "required": true, - "type": "string" + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", @@ -74780,113 +76062,128 @@ "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "hideipaddressusage", + "name": "displaynetwork", "required": false, "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "ip6cidr", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the zone ID for the network", "length": 255, - "name": "startipv6", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the network", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "gateway", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the beginning IP address in the network IP range", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "startip", + "name": "isolatedpvlantype", "required": false, "type": "string" }, { - "description": "the ID or VID of the network", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "vlan", + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.17.0", + "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "network domain", "length": 255, - "name": "endipv6", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "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": "bypassvlanoverlapcheck", + "name": "subdomainaccess", "required": false, "type": "boolean" }, { - "description": "ID of the network in an external system.", + "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": "externalid", + "name": "acltype", "required": false, "type": "string" }, { - "description": "the zone ID for the network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "name": "startipv6", + "required": false, "type": "string" }, - {}, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "domain ID of the account owning a network", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the type of the network", - "name": "type", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -74895,98 +76192,89 @@ "type": "map" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "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 network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "The external id of the network", - "name": "externalid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "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 traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "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": "state of the network", + "name": "state", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -74995,85 +76283,231 @@ "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "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 network owner", - "name": "domain", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the id of the network", - "name": "id", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "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 supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the list of services", - "name": "service", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "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 service name", - "name": "name", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "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": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", + "response": [ { "description": "the service provider name", "name": "provider", @@ -75083,24 +76517,14 @@ "name": "servicelist", "type": "list" }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -75112,6 +76536,16 @@ "description": "state of the network provider", "name": "state", "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" } ], "type": "list" @@ -75120,11 +76554,6 @@ "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, { "description": "the capability value", "name": "value", @@ -75134,150 +76563,74 @@ "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": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, { "description": "list networks that are persistent", "name": "ispersistent", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", + "description": "VPC the network belongs to", + "name": "vpcid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - } + {} ] }, { @@ -75286,71 +76639,68 @@ "name": "listNetworkOfferings", "params": [ { - "description": "the availability of network offering. Default value is required", + "description": "", "length": 255, - "name": "availability", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list network offerings by ID", + "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": "id", - "related": "listNetworkOfferings", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "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": "true if offering has tags specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "istagged", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "guestiptype", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "list network offerings by state", + "description": "the tags for the network offering.", "length": 255, - "name": "state", + "name": "specifyvlan", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list by traffic type", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "", + "description": "list network offerings by display text", "length": 255, - "name": "page", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the tags for the network offering.", + "description": "list network offerings by name", "length": 255, - "name": "specifyvlan", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by traffic type", + "description": "list network offerings supporting certain services", "length": 255, - "name": "traffictype", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { "description": "", @@ -75360,32 +76710,35 @@ "type": "integer" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "isdefault", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "forvpc", + "name": "sourcenatsupported", "required": false, "type": "boolean" }, { - "description": "true if offering has tags specified", + "description": "List by keyword", "length": 255, - "name": "istagged", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by name", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { "description": "list network offerings by tags", @@ -75395,96 +76748,105 @@ "type": "string" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "guestiptype", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "list network offerings by ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "id", + "related": "listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "specifyipranges", + "name": "isdefault", "required": false, "type": "boolean" }, { - "description": "list network offerings by display text", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "displaytext", + "name": "specifyipranges", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "list network offerings by state", "length": 255, - "name": "sourcenatsupported", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings supporting certain services", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "supportedservices", + "name": "availability", "required": false, - "type": "list" + "type": "string" } ], "related": "", "response": [ { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the 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 offering", + "name": "id", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "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 the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network offering", + "name": "name", "type": "string" }, - {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, { "description": "true if network offering supports vlans, false otherwise", @@ -75492,55 +76854,25 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, - { - "description": "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", - "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", @@ -75549,6 +76881,11 @@ "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", @@ -75558,37 +76895,32 @@ "description": "the capability value", "name": "value", "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -75597,72 +76929,98 @@ "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, + {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" + "description": "the 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": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + {}, + { + "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 guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, { "description": "maximum number of concurrents connections to be handled by lb", "name": "maxconnections", "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "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": "availability of the network offering", - "name": "availability", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -75671,12 +77029,11 @@ "name": "listDedicatedPods", "params": [ { - "description": "the ID of the pod", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -75685,13 +77042,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of the domain associated with the pod", "length": 255, @@ -75701,12 +77051,11 @@ "type": "uuid" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the name of the account associated with the pod. Must be used with domainId.", @@ -75716,57 +77065,66 @@ "type": "string" }, { - "description": "", + "description": "the ID of the pod", "length": 255, - "name": "page", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list dedicated pods by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "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", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Account Id to which the Pod is dedicated", "name": "accountid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "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", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Name of the Pod", "name": "podname", "type": "string" - } + }, + {}, + { + "description": "the ID of the Pod", + "name": "podid", + "type": "string" + }, + {} ] }, { @@ -75793,7 +77151,7 @@ "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" } @@ -75801,165 +77159,29 @@ "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", - "type": "boolean" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "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": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "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 description of the affinity group", "name": "description", @@ -75970,242 +77192,235 @@ "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", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "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", "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "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 type of the ICMP message response", - "name": "icmptype", - "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 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", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "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": "account owning the security group rule", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the 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 ending IP of the security group rule ", @@ -76217,19 +77432,29 @@ "name": "account", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -76237,43 +77462,33 @@ "name": "cidr", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -76282,234 +77497,205 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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 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", - "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "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": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - {}, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "the group name of the virtual machine", "name": "group", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "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": "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "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 IPv6 address of network", - "name": "ip6address", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -76518,23 +77704,18 @@ "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -76543,33 +77724,28 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, - { - "description": "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", - "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", + "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": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -76578,52 +77754,57 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of 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", @@ -76631,29 +77812,39 @@ "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", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "the account associated with the virtual machine", @@ -76661,28 +77852,59 @@ "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -76690,26 +77912,51 @@ "name": "sentbytes", "type": "long" }, - {}, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "the name of the virtual machine", @@ -76717,8 +77964,13 @@ "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -76726,30 +77978,136 @@ "name": "zonename", "type": "string" }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, { "description": "OS name of the vm", "name": "osdisplayname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" } ] }, @@ -76759,127 +78117,127 @@ "name": "listVPCs", "params": [ { - "description": "list VPCs by restartRequired option", + "description": "", "length": 255, - "name": "restartrequired", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list VPCs by state", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "state", + "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 VPC supporting certain services", "length": 255, - "name": "listall", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "list by name of the VPC", "length": 255, - "name": "cidr", + "name": "name", "required": false, "type": "string" }, { - "description": "list by zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "page", + "name": "cidr", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list objects by project", + "description": "List by display text of the VPC", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "displaytext", "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": "list VPCs by restartRequired option", "length": 255, - "name": "isrecursive", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "flag to display the resource icon for VPCs", + "description": "list by zone", "length": 255, - "name": "showicon", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC supporting certain services", + "description": "list VPCs by state", "length": 255, - "name": "supportedservices", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "List by display text of the VPC", + "description": "list by ID of the VPC offering", "length": 255, - "name": "displaytext", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list by name of the VPC", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by ID of the VPC offering", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list VPC by id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -76890,17 +78248,17 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list VPC by id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" } @@ -76908,8 +78266,8 @@ "related": "createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { @@ -76923,44 +78281,47 @@ "type": "list" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, - {}, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, - {}, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", @@ -76968,32 +78329,32 @@ "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, { "description": "the capability value", "name": "value", @@ -77003,6 +78364,11 @@ "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" @@ -77011,52 +78377,79 @@ "type": "list" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, + {}, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "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": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -77064,72 +78457,72 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "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 routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "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": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { @@ -77138,38 +78531,8 @@ "type": "string" }, { - "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 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", - "type": "string" - }, - { - "description": "the id of the VPC", - "name": "id", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" } ] @@ -77180,61 +78543,61 @@ "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", + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, - "name": "ipaddress", + "name": "type", "required": true, "type": "string" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "The IP/Domain address to test connection to", "length": 255, - "name": "type", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", - "required": true, - "type": "uuid" + "name": "params", + "required": false, + "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", + "description": "the standard output from the command execution", + "name": "stdout", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the command execution return code", "name": "exitcode", "type": "string" }, - {}, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the standard error output from the command execution", + "name": "stderr", "type": "string" }, {} @@ -77263,18 +78626,18 @@ ], "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", @@ -77288,30 +78651,23 @@ "name": "updateUser", "params": [ { - "description": "last name", - "length": 255, - "name": "lastname", - "required": false, - "type": "string" - }, - { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "first name", "length": 255, - "name": "usersecretkey", + "name": "firstname", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "email", "length": 255, - "name": "timezone", + "name": "email", "required": false, "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "last name", "length": 255, - "name": "userapikey", + "name": "lastname", "required": false, "type": "string" }, @@ -77323,24 +78679,16 @@ "type": "string" }, { - "description": "User uuid", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, - "type": "uuid" - }, - { - "description": "first name", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "firstname", + "name": "timezone", "required": false, "type": "string" }, { - "description": "email", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "email", + "name": "usersecretkey", "required": false, "type": "string" }, @@ -77357,38 +78705,60 @@ "name": "currentpassword", "required": false, "type": "string" + }, + { + "description": "User uuid", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "required": true, + "type": "uuid" + }, + { + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", + "required": false, + "type": "string" } ], "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ { - "description": "the type of the role", - "name": "roletype", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user name", + "name": "username", + "type": "string" }, { - "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 domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + {}, + { + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -77397,65 +78767,68 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the 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 ID of the role", + "name": "roleid", "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 UUID of the latest async job acting on 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 api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -77469,18 +78842,8 @@ "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", + "description": "the user firstname", + "name": "firstname", "type": "string" } ] @@ -77490,6 +78853,21 @@ "isasync": true, "name": "restartVPC", "params": [ + { + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" + }, + { + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, { "description": "Turn a single VPC into a redundant one.", "length": 255, @@ -77504,38 +78882,31 @@ "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" - }, - { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "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" + } ] }, { @@ -77547,29 +78918,29 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "", + "related": "updateIpv6FirewallRule", "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": "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", @@ -77583,10 +78954,10 @@ "name": "addHost", "params": [ { - "description": "the Pod ID for the host", + "description": "the Zone ID for the host", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, @@ -77598,120 +78969,179 @@ "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "clusterid", + "related": "addCluster", + "required": false, "type": "uuid" }, { - "description": "the host URL", + "description": "list of tags to be added to the host", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "hosttags", + "required": false, + "type": "list" }, { - "description": "the cluster name for the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clustername", + "name": "password", "required": false, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the Pod ID for the host", "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the cluster name for the host", "length": 255, - "name": "username", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "the host URL", "length": 255, - "name": "password", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "hosttags", + "name": "allocationstate", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "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 IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum 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 displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the host", + "name": "zonename", "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 name of the host", @@ -77719,86 +79149,76 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, { "description": "the ID of the host", "name": "id", "type": "string" }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, {}, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, - {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", @@ -77806,59 +79226,59 @@ "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 Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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 last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { "description": "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", @@ -77866,158 +79286,109 @@ "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "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 Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the 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 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": "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 hypervisor version", + "name": "hypervisorversion", + "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 amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the host version", - "name": "version", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the last time this host was annotated", + "name": "lastannotated", + "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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" } ] }, @@ -78026,6 +79397,14 @@ "isasync": true, "name": "attachVolume", "params": [ + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, { "description": "the ID of the disk volume", "length": 255, @@ -78035,361 +79414,358 @@ "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. When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", "length": 255, "name": "deviceid", "required": false, "type": "long" - }, - { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" } ], "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the path of the volume", - "name": "path", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "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 path of the volume", + "name": "path", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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 account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, + {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "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": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the virtual machine", + "name": "vmname", "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": "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": "min iops of the disk volume", "name": "miniops", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "cluster id of the volume", + "name": "clusterid", "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 service offering for root disk", - "name": "serviceofferingdisplaytext", - "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": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "the date the volume was attached to a VM instance", "name": "attached", "type": "date" }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { "description": "the UUID of the latest async job acting on this object", @@ -78397,43 +79773,43 @@ "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": "the project name of the vpn", + "name": "project", + "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "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", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" } ] @@ -78450,6 +79826,13 @@ "required": true, "type": "string" }, + { + "description": "Credentials to reach external dhcp device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -78465,13 +79848,6 @@ "required": true, "type": "string" }, - { - "description": "Credentials to reach external dhcp device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "Type of dhcp device", "length": 255, @@ -78482,11 +79858,17 @@ ], "related": "listBaremetalDhcp", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "url", "name": "url", @@ -78497,27 +79879,21 @@ "name": "dhcpservertype", "type": "string" }, - {}, + { + "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": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" } ] }, @@ -78526,13 +79902,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, @@ -78542,10 +79911,10 @@ "type": "uuid" }, { - "description": "URL of the traffic monitor Host", + "description": "Traffic going into the listed zones will not be metered", "length": 255, - "name": "url", - "required": true, + "name": "excludezones", + "required": false, "type": "string" }, { @@ -78554,10 +79923,33 @@ "name": "includezones", "required": false, "type": "string" + }, + { + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the external firewall", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -78578,22 +79970,6 @@ "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 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" } ] }, @@ -78602,6 +79978,13 @@ "isasync": true, "name": "updateProject", "params": [ + { + "description": "Account level role to be assigned to the user/account : Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, { "description": "ID of the user to be promoted/demoted", "length": 255, @@ -78611,16 +79994,16 @@ "type": "uuid" }, { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "description": "new Admin account for the project", "length": 255, - "name": "swapowner", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "display text of the project", "length": 255, - "name": "roletype", + "name": "displaytext", "required": false, "type": "string" }, @@ -78633,18 +80016,11 @@ "type": "uuid" }, { - "description": "new Admin account for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "display text of the project", + "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": "displaytext", + "name": "swapowner", "required": false, - "type": "string" + "type": "boolean" } ], "related": "activateProject,suspendProject", @@ -78655,28 +80031,23 @@ "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { @@ -78685,168 +80056,174 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "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 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", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "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", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the project", - "name": "name", + "description": "the total volume available for this project", + "name": "volumeavailable", "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 templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the id of the project", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, + {}, { "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", + "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 snapshots stored by this project", + "name": "snapshottotal", + "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 available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the total number of public ip addresses this project can acquire", "name": "iplimit", "type": "string" }, {}, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -78855,8 +80232,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -78868,40 +80245,39 @@ "type": "list" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, - {}, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { "description": "the total number of cpu cores owned by project", @@ -78909,38 +80285,38 @@ "type": "long" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" } ], @@ -78951,14 +80327,6 @@ "isasync": false, "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.", "length": 255, @@ -78967,35 +80335,33 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the load balancer", "length": 255, - "name": "account", + "name": "id", + "related": "updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the network ID of the source IP address", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "scheme", "required": false, - "type": "uuid" + "type": "string" }, { - "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", @@ -79015,106 +80381,134 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "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": "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": "the network ID of the load balancer", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "", "length": 255, - "name": "scheme", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the source IP address of the load balancer", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "sourceipaddress", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the source IP address of the load balancer", "length": 255, - "name": "page", + "name": "sourceipaddress", "required": false, - "type": "integer" + "type": "string" } ], "related": "createLoadBalancer", "response": [ - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, { "description": "the account of the Load Balancer", "name": "account", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", "response": [ { - "description": "tag value", - "name": "value", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the instance ID", + "name": "id", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -79123,55 +80517,43 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ + }, { - "description": "the name of the instance", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -79183,61 +80565,33 @@ "type": "integer" }, { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - } - ], - "type": "list" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { @@ -79246,14 +80600,36 @@ "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" } ], "since": "4.2.0" @@ -79264,67 +80640,61 @@ "name": "listUsers", "params": [ { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "List by keyword", "length": 255, - "name": "accounttype", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List user by the username", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "username", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List 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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "", + "description": "flag to display the resource icon for users", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List users by state of the user account.", + "description": "List user by the username", "length": 255, - "name": "state", + "name": "username", "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 resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List user by ID.", @@ -79335,38 +80705,33 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List users by state of the user account.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "state", "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": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "isrecursive", + "name": "accounttype", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createUser,disableUser,enableUser,getUser", "response": [ { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - {}, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", @@ -79374,13 +80739,13 @@ "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 ID of the role", + "name": "roleid", "type": "string" }, { @@ -79389,44 +80754,33 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "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 name of the role", - "name": "rolename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user ID", + "name": "id", "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", - "type": "string" - }, - {}, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -79440,18 +80794,18 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -79460,18 +80814,40 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user name", + "name": "username", "type": "string" } ] @@ -79492,6 +80868,13 @@ ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the api key of the registered user", "name": "apikey", @@ -79502,13 +80885,6 @@ "name": "secretkey", "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", @@ -79531,28 +80907,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": "3.0.0" }, @@ -79561,13 +80937,6 @@ "isasync": false, "name": "updateVlanIpRange", "params": [ - { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, { "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, @@ -79583,47 +80952,47 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "id", + "related": "updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "endip", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the gateway of the IPv6 network", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "startip", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "endip", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "startip", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the UUID of the VLAN IP range", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" + "name": "ip6gateway", + "required": false, + "type": "string" }, { "description": "the gateway of the VLAN IP range", @@ -79631,73 +81000,86 @@ "name": "gateway", "required": false, "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" } ], "related": "dedicatePublicIpRange", "response": [ { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "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 end ip of the VLAN IP range", + "name": "endip", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, + {}, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { @@ -79711,23 +81093,18 @@ "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 virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { @@ -79735,31 +81112,35 @@ "name": "networkid", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "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": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" } ], @@ -79771,59 +81152,59 @@ "name": "listVpnConnections", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "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": "id of the vpn connection", + "description": "", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "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": "", + "description": "id of the vpn connection", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVpnConnection,listVpnConnections", "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": "id of vpc", "length": 255, - "name": "isrecursive", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "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", @@ -79831,49 +81212,44 @@ "type": "uuid" }, { - "description": "id of vpc", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "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" } ], "related": "createVpnConnection", "response": [ { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "public ip address id of the customer gateway", + "name": "gateway", "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 owner", @@ -79881,20 +81257,15 @@ "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -79902,95 +81273,105 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name", + "name": "project", "type": "string" }, - {}, { "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "name": "state", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "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": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "State of vpn connection", - "name": "state", + "name": "passive", + "type": "boolean" + }, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "is connection for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, + {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "ESP policy of the 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 customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -80000,95 +81381,95 @@ "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": "list only resources belonging to the domain specified", "length": 255, - "name": "resourcetypename", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists resource limits by ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "long" + "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 by keyword", + "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": "keyword", + "name": "resourcetype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list objects by project", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "resourcetypename", "required": false, - "type": "uuid" + "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": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "Lists resource limits by ID.", "length": 255, - "name": "listall", + "name": "id", "required": false, - "type": "boolean" + "type": "long" } ], "related": "", "response": [ { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", + "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { @@ -80098,8 +81479,8 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { @@ -80108,30 +81489,30 @@ "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -80151,85 +81532,96 @@ ], "related": "createUser,enableUser,getUser", "response": [ - {}, { - "description": "the type of the role", - "name": "roletype", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "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", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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 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 name of the role", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, + { + "description": "the account name of the user", + "name": "account", + "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 api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -80238,39 +81630,28 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the user", - "name": "domain", + "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 api key of the user", - "name": "apikey", + "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 account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user state", + "name": "state", "type": "string" } ] @@ -80281,66 +81662,54 @@ "name": "listIsos", "params": [ { - "description": "true if the ISO is bootable, false otherwise", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "bootable", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "the ID of the zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "account", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hypervisor", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list all ISOs by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "If set to false, list only 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" }, @@ -80352,33 +81721,40 @@ "type": "integer" }, { - "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 ISO by ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list all ISOs by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to true, list only unique isos across zones", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "showunique", + "name": "hypervisor", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", @@ -80388,54 +81764,74 @@ "type": "string" }, { - "description": "show removed ISOs as well", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "showremoved", + "name": "isready", "required": false, "type": "boolean" }, { - "description": "list objects by project", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list ISO by ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "flag to display the resource image for the isos", + "description": "show removed ISOs as well", "length": 255, - "name": "showicon", + "name": "showremoved", "required": false, "type": "boolean" + }, + { + "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 secondary storage host for the template", - "name": "hostname", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "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", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -80444,8 +81840,38 @@ "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if 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" }, { @@ -80454,8 +81880,13 @@ "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "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", "type": "string" }, { @@ -80463,38 +81894,114 @@ "name": "icon", "type": "resourceiconresponse" }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "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 name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "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": "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -80503,13 +82010,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -80526,54 +82043,14 @@ "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" } ], "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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "true if the template is ready to be deployed from, false otherwise.", @@ -80581,131 +82058,45 @@ "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "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": "the account name to which the template belongs", "name": "account", "type": "string" }, + {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "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 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 ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "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", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "checksum of the template", + "name": "checksum", "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 date this template was removed", + "name": "removed", + "type": "date" }, { "description": "the ID of the zone for this template", @@ -80713,23 +82104,13 @@ "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", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" } ] @@ -80740,10 +82121,10 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the image store provider name", + "description": "the name for the image store", "length": 255, - "name": "provider", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -80761,23 +82142,18 @@ "type": "string" }, { - "description": "the name for the image store", + "description": "the image store provider name", "length": 255, - "name": "name", - "required": false, + "name": "provider", + "required": true, "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", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -80786,62 +82162,67 @@ "type": "scopetype" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, - { - "description": "the 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", - "type": "string" - }, - {}, { "description": "the Zone ID of the image store", "name": "zoneid", "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": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - } + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + {} ], "since": "4.3.0" }, @@ -80851,83 +82232,83 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "the ID of the condition of the policy", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "conditionid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the autoscale vm group", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "keyword", + "name": "vmgroupid", + "related": "listAutoScaleVmGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "", "length": 255, - "name": "action", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the condition of the policy", + "description": "the ID of the autoscale policy", "length": 255, - "name": "conditionid", - "related": "", + "name": "id", + "related": "listAutoScalePolicies", "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": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "account", + "name": "action", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -80935,13 +82316,13 @@ "related": "", "response": [ { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the project name of the autoscale policy", + "name": "project", "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" }, { @@ -80950,31 +82331,35 @@ "type": "integer" }, { - "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", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the 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", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, - {}, + { + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, {}, { "description": "the list of IDs of the conditions that are being evaluated on every interval", @@ -80982,18 +82367,14 @@ "type": "list" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "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 autoscale policy ID", - "name": "id", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" } ] @@ -81018,21 +82399,21 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "url", "name": "url", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of rct", + "name": "id", "type": "string" }, {}, { - "description": "id of rct", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -81043,12 +82424,11 @@ "name": "updateRole", "params": [ { - "description": "ID of the role", + "description": "The description of the role", "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { "description": "creates a role with this unique name", @@ -81058,11 +82438,12 @@ "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "ID of the role", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "id", + "related": "importRole,listRoles,updateRole", + "required": true, + "type": "uuid" }, { "description": "The description of the role", @@ -81072,9 +82453,9 @@ "type": "string" }, { - "description": "The description of the role", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "description", + "name": "type", "required": false, "type": "string" } @@ -81091,32 +82472,32 @@ "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the description of the role", + "name": "description", + "type": "string" }, { "description": "the type of the role", "name": "type", "type": "string" }, - { - "description": "the name of the role", - "name": "name", - "type": "string" - }, { "description": "the ID of the role", "name": "id", "type": "string" }, + {}, + {}, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" + }, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "since": "4.9.0" @@ -81127,33 +82508,33 @@ "name": "listVmwareDcs", "params": [ { - "description": "Id of the CloudStack zone.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Id of the CloudStack zone.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "addVmwareDc", @@ -81165,20 +82546,15 @@ }, {}, { - "description": "the current status of the latest 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 vCenter name/ip", + "name": "vcenter", "type": "string" }, {}, { - "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 Zone ID associated with this VMware Datacenter", @@ -81189,6 +82565,11 @@ "description": "The VMware Datacenter ID", "name": "id", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -81198,26 +82579,26 @@ "name": "listZones", "params": [ { - "description": "List by keyword", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "keyword", + "name": "available", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "available", + "name": "tags", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "the ID of the domain associated with the zone", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the zone", @@ -81228,11 +82609,11 @@ "type": "uuid" }, { - "description": "the name of the zone", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "name", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -81256,43 +82637,45 @@ "type": "boolean" }, { - "description": "", + "description": "the name of the zone", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "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": "List zones by resource tags (key/value pairs)", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", - "type": "map" + "type": "uuid" } ], "related": "createZone,listZones", "response": [ { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, + {}, + {}, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -81301,86 +82684,101 @@ "type": "resourceiconresponse" }, { - "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 internal DNS for the Zone", - "name": "internaldns2", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], - "type": "set" + "type": "list" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { "description": "the first internal DNS for the Zone", @@ -81388,14 +82786,14 @@ "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { "description": "Zone id", @@ -81403,28 +82801,23 @@ "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "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", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { @@ -81433,103 +82826,91 @@ "type": "map" }, { - "description": "Zone description", - "name": "description", - "type": "string" - }, - {}, - {}, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "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", - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "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", + "type": "string" }, { "description": "Zone Token", "name": "zonetoken", "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" } ] }, @@ -81539,144 +82920,130 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "list objects by project", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "id", + "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "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": "public ip address id of the vpn server", + "description": "list remote access VPNs for ceratin network", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", "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": "list remote access VPNs for ceratin network", + "description": "public ip address id of the vpn server", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "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": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "updateRemoteAccessVpn", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, { "description": "is vpn for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -81684,26 +83051,40 @@ "name": "publicip", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, - {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { "description": "the public ip address of the vpn server", "name": "publicipid", "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" } ] }, @@ -81722,56 +83103,12 @@ } ], "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", @@ -81782,9 +83119,13 @@ "name": "jobid", "type": "string" }, - {} - ], - "since": "4.14.0" + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { "description": "Removes secondary IP from the NIC.", @@ -81801,12 +83142,12 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -81817,12 +83158,12 @@ "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" + }, + {} ] }, { @@ -81831,58 +83172,43 @@ "name": "createServiceInstance", "params": [ { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "The name of the service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "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" }, - { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "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 template ID that specifies the image for the service appliance", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" }, { - "description": "An optional account for the virtual machine. Must be used with domainId.", + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Project ID for the service instance", @@ -81893,121 +83219,66 @@ "type": "uuid" }, { - "description": "The template ID that specifies the image for the service appliance", + "description": "Availability zone for the service instance", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "The service offering ID that defines the resources consumed by the service appliance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "An optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the project name of the vm", - "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", "type": "string" }, - { - "description": "the name of the virtual machine", - "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, + "description": "the project name of the vm", + "name": "project", "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": "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": "importBackupOffering", - "response": [ - { - "description": "ID of the backup offering", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -82016,38 +83287,16 @@ "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", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", - "type": "string" - }, - { - "description": "external ID on the provider side", - "name": "externalid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Releases a Public IP range back to the system pool", @@ -82064,27 +83313,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "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" } ] }, @@ -82093,6 +83342,13 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "netscaler load balancer device ID", "length": 255, @@ -82114,112 +83370,124 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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", - "type": "string" - }, { "description": "an optional field, whether to the display the network to the end user or not.", "name": "displaynetwork", "type": "boolean" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of services", + "name": "service", "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 service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "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" } ], "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "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" }, { - "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 project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { @@ -82227,55 +83495,50 @@ "name": "created", "type": "date" }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, { "description": "true if network supports specifying ip ranges, false otherwise", "name": "specifyipranges", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { "description": "true if network offering is ip conserve mode enabled", @@ -82283,272 +83546,298 @@ "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "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 available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, + {}, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the id of the network", + "name": "id", "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" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "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 physical network id", - "name": "physicalnetworkid", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, - {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the service name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "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": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "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 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" - } - ], - "type": "list" + "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 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": "list" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" } ] }, @@ -82569,129 +83858,138 @@ "related": "migrateSystemVm", "response": [ { - "description": "the systemvm agent version", - "name": "version", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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 Pod ID for the system VM", - "name": "podid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "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.", + "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 job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 private netmask for the system VM", - "name": "privatenetmask", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -82699,46 +83997,47 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { "description": "the hypervisor on which the template runs", @@ -82746,26 +84045,72 @@ "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + } + ] + }, + { + "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 first DNS for the system VM", - "name": "dns1", + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Lists supported methods of network isolation", @@ -82773,25 +84118,25 @@ "name": "listNetworkIsolationMethods", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -82801,76 +84146,121 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Network isolation method name", "name": "name", "type": "string" }, - {} + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, { - "description": "Lists host HA resources", + "description": "Lists VM stats", "isasync": false, - "name": "listHostHAResources", + "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "List by host ID", + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "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": "uuid" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", - "response": [ + "type": "list" + }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "uuid" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "end date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, + { + "description": "start date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + } + ], + "related": "", + "response": [ {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of VM stats", + "name": "stats", + "type": "list" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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,223 +84271,292 @@ "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", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the 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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the 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 ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, + {}, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the host version", + "name": "version", "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": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "id", + "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 used", + "name": "cpuused", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the host version", - "name": "version", - "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", - "name": "oscategoryname", + "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 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 resource state of the host", + "name": "resourcestate", "type": "string" }, + {}, { "description": "the incoming network traffic on the host", "name": "networkkbsread", "type": "long" }, { - "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 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": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { @@ -83106,73 +84565,14 @@ "type": "integer" }, { - "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { "description": "the state of the host", @@ -83180,73 +84580,63 @@ "type": "status" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" } ], @@ -83257,22 +84647,6 @@ "isasync": true, "name": "createKubernetesCluster", "params": [ - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Network in which Kubernetes cluster is to be launched", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, @@ -83288,60 +84662,82 @@ "type": "long" }, { - "description": "Deploy cluster for the project", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "description for the Kubernetes cluster", + "description": "user name for the docker image private registry", "length": 255, - "name": "description", - "required": true, + "name": "dockerregistryusername", + "required": false, "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "noderootdisksize", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "length": 255, + "name": "masternodes", "required": false, "type": "long" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "size", "required": true, - "type": "uuid" + "type": "long" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, + "type": "uuid" + }, + { + "description": "name for the Kubernetes cluster", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "password for the docker image private registry", "length": 255, - "name": "dockerregistryusername", + "name": "dockerregistrypassword", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "masternodes", + "name": "description", + "required": true, + "type": "string" + }, + { + "description": "root disk size in GB for each node", + "length": 255, + "name": "noderootdisksize", "required": false, "type": "long" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "URL for the docker image private registry", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "dockerregistryurl", "required": false, "type": "string" }, @@ -83354,93 +84750,93 @@ "type": "uuid" }, { - "description": "URL for the docker image private registry", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "dockerregistryurl", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": true, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "name for the Kubernetes cluster", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "name", - "required": true, + "name": "externalloadbalanceripaddress", + "required": false, "type": "string" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "Deploy cluster for the project", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "number of Kubernetes cluster worker nodes", - "length": 255, - "name": "size", - "required": true, - "type": "long" - }, - { - "description": "password for the docker image private registry", - "length": 255, - "name": "dockerregistrypassword", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "startKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, + {}, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { @@ -83449,19 +84845,19 @@ "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { "description": "keypair details", @@ -83469,105 +84865,99 @@ "type": "string" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "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", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -83577,33 +84967,27 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "page", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", @@ -83614,46 +84998,57 @@ "type": "uuid" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" }, { "description": "the Zone uuid of the storage network IP range", "name": "zoneid", "type": "string" }, + {}, { "description": "the network uuid of storage network IP range", "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, {}, - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { @@ -83662,13 +85057,8 @@ "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 gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { @@ -83677,91 +85067,48 @@ "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" }, { - "description": "Imports a backup offering using a backup provider", + "description": "Enables HA for a host", "isasync": true, - "name": "importBackupOffering", + "name": "enableHAForHost", "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 the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "the name of the backup offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], - "related": "", + "related": "configureHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "zone name", - "name": "zonename", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, {}, { - "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", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -83769,32 +85116,25 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, {}, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", + "description": "if host HA is enabled for the host", + "name": "haenable", "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.14.0" + "since": "4.11" }, { "description": "Configures a virtual router element.", "isasync": true, "name": "configureVirtualRouterElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the virtual router provider", "length": 255, @@ -83802,31 +85142,43 @@ "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "listVirtualRouterElements", "response": [ { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, + {}, { "description": "the domain associated with the provider", "name": "domain", "type": "string" }, - {}, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, { "description": "the account associated with the provider", "name": "account", @@ -83837,27 +85189,22 @@ "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", + "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" + }, + {} ] }, { @@ -83865,89 +85212,34 @@ "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" - } - ], - "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": "Enables HA for a host", - "isasync": true, - "name": "enableHAForHost", - "params": [ - { - "description": "ID of the host", + "description": "ID of domain to delete", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "id", + "related": "listDomainChildren,listDomains", "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, {}, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the host HA provider", - "name": "haprovider", - "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", @@ -83955,25 +85247,17 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ], - "since": "4.11" + ] }, { "description": "Migrate volume", "isasync": true, "name": "migrateVolume", "params": [ - { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", - "length": 255, - "name": "newdiskofferingid", - "required": false, - "type": "string" - }, { "description": "destination storage pool ID to migrate the volume to", "length": 255, @@ -83990,6 +85274,14 @@ "required": true, "type": "uuid" }, + { + "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", + "length": 255, + "name": "newdiskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, @@ -84001,54 +85293,43 @@ "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", + "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", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "cluster id of the volume", - "name": "clusterid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { @@ -84057,83 +85338,69 @@ "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { @@ -84142,23 +85409,18 @@ "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -84166,23 +85428,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -84191,8 +85448,8 @@ "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" }, { @@ -84201,71 +85458,72 @@ "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", + "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "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 project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -84274,118 +85532,212 @@ "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "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": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "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": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "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": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ + { + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" + } + ], + "related": "configureHAForHost,disableHAForHost", + "response": [ + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "operation status", + "name": "status", "type": "boolean" } ], - "since": "3.0.0" + "since": "4.11" }, { "description": "A command to list events.", @@ -84393,83 +85745,93 @@ "name": "listEvents", "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": "boolean" + }, + { + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the 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 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": "startid", - "related": "listEvents", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "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,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "level", + "name": "domainid", + "related": "listDomainChildren,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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the event", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listEvents", "required": false, "type": "uuid" }, { - "description": "", + "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", "length": 255, - "name": "page", + "name": "startid", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the time the event was entered", + "description": "", "length": 255, - "name": "entrytime", + "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": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "listall", + "name": "level", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project", + "description": "the time the event was entered", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "entrytime", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the event type (see event types)", + "description": "the type of the resource associated with the event", "length": 255, - "name": "type", + "name": "resourcetype", "required": false, + "since": "4.17.0", "type": "string" }, { @@ -84480,87 +85842,98 @@ "type": "date" }, { - "description": "the ID of the event", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listEvents", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the duration of the event", + "description": "", "length": 255, - "name": "duration", + "name": "page", "required": false, "type": "integer" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "the event type (see event types)", "length": 255, - "name": "startdate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { - "description": "", + "description": "the duration of the event", "length": 255, - "name": "pagesize", + "name": "duration", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, - {}, { "description": "the id of the account's domain", "name": "domainid", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, + {}, { "description": "the state of the event", "name": "state", "type": "state" }, { - "description": "the project name of the address", - "name": "project", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "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" + }, + { + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { @@ -84569,18 +85942,28 @@ "type": "date" }, { - "description": "the ID of the event", - "name": "id", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the event", + "name": "id", + "type": "string" + }, + { + "description": "the name of the resource", + "name": "resourcename", "type": "string" }, { @@ -84595,14 +85978,6 @@ "isasync": true, "name": "updateVMAffinityGroup", "params": [ - { - "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": true, - "type": "uuid" - }, { "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, @@ -84618,372 +85993,181 @@ "related": "", "required": false, "type": "list" + }, + { + "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": true, + "type": "uuid" } ], "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "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": "the project id of the vm", - "name": "projectid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "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 write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - {}, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "Vm details in key/value pairs.", + "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 name of the host for the virtual machine", - "name": "hostname", + "description": "Guest vm Boot Type", + "name": "boottype", "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", + "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 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", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the domain ID of the security 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": "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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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 name of the security group", + "name": "name", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -84991,38 +86175,38 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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" }, { - "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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -85031,8 +86215,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -85044,103 +86228,26 @@ "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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", - "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -85148,35 +86255,20 @@ "name": "virtualmachineids", "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "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", @@ -85187,58 +86279,78 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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", @@ -85250,139 +86362,131 @@ "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" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "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", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "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": "publicipid", + "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", + "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 ID of the virtual machine", - "name": "id", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the 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", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -85391,83 +86495,72 @@ "type": "boolean" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -85481,64 +86574,59 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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 IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "the isolation uri of the nic", @@ -85546,89 +86634,329 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - } - ] - }, - { - "description": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ], - "related": "configureHAForHost,disableHAForHost", - "response": [ + }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, - {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "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 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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "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 group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" } - ], - "since": "4.11" + ] }, { "description": "Registers NCC Service Package", @@ -85636,35 +86964,30 @@ "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", + "description": "Service Package Name", + "name": "name", "type": "string" }, {}, @@ -85673,6 +86996,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -85693,13 +87021,6 @@ "required": true, "type": "list" }, - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": true, - "type": "map" - }, { "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, @@ -85713,9 +87034,21 @@ "name": "resourcetype", "required": true, "type": "string" + }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": true, + "type": "map" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "any text associated with the success or failure", @@ -85728,11 +87061,6 @@ "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", @@ -85764,129 +87092,130 @@ ], "related": "", "response": [ + {}, { - "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": "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 number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "device name", + "name": "fwdevicename", + "type": "string" }, - {}, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, + {}, { "description": "the private security zone of the external firewall", "name": "privatezone", "type": "string" }, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "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 username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" } ] }, { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", - "isasync": false, - "name": "listCaCertificate", + "description": "Create an Internal Load Balancer element.", + "isasync": true, + "name": "createInternalLoadBalancerElement", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "the network service provider ID of the internal load balancer element", "length": 255, - "name": "provider", - "required": false, - "type": "string" + "name": "nspid", + "related": "listNetworkServiceProviders", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "configureInternalLoadBalancerElement", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { - "description": "The client certificate", - "name": "certificate", - "type": "string" + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, {}, @@ -85896,38 +87225,32 @@ "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "4.11.0" + "since": "4.2.0" }, { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", "params": [ { - "description": "the network service provider ID of the internal load balancer element", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" + "name": "provider", + "required": false, + "type": "string" } ], - "related": "configureInternalLoadBalancerElement", + "related": "", "response": [ { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -85935,19 +87258,24 @@ "type": "string" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" }, + {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The client certificate", + "name": "certificate", "type": "string" }, - {}, {} ], - "since": "4.2.0" + "since": "4.11.0" }, { "description": "Reset api count", @@ -85970,9 +87298,9 @@ "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", @@ -85981,9 +87309,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" }, {} ] @@ -86004,10 +87332,11 @@ ], "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", @@ -86019,60 +87348,50 @@ "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": "Creates a Project role", + "description": "Provisions a host with a direct download certificate", "isasync": false, - "name": "updateProjectRole", + "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "ID of the Project role", + "description": "the id of the direct download certificate to provision", "length": 255, "name": "id", - "related": "updateProjectRole", + "related": "uploadTemplateDirectDownloadCertificate", "required": true, "type": "uuid" }, { - "description": "ID of project where role is being created", + "description": "the host to provision the certificate", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the role", - "name": "id", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -86081,37 +87400,25 @@ "type": "integer" }, { - "description": "the id of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, {}, {}, { - "description": "the name of the role", - "name": "name", + "description": "the name of the host", + "name": "hostname", "type": "string" } ], - "since": "4.15.0" + "since": "4.17.0" }, { "description": "Generates an alert", "isasync": true, "name": "generateAlert", "params": [ - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - }, { "description": "Zone id for which alert is generated", "length": 255, @@ -86120,6 +87427,13 @@ "required": false, "type": "uuid" }, + { + "description": "Name of the alert", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Pod id for which alert is generated", "length": 255, @@ -86136,14 +87450,15 @@ "type": "string" }, { - "description": "Name of the alert", + "description": "Type of the alert", "length": 255, - "name": "name", + "name": "type", "required": true, - "type": "string" + "type": "short" } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -86160,7 +87475,6 @@ "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -86169,17 +87483,90 @@ ], "since": "4.3" }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "updateProjectRole", + "params": [ + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", + "required": true, + "type": "uuid" + }, + { + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" + }, + { + "description": "creates a project role with this unique name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.15.0" + }, { "description": "Add a new Ldap Configuration", "isasync": false, "name": "addLdapConfiguration", "params": [ { - "description": "Port", + "description": "Hostname", "length": 255, - "name": "port", + "name": "hostname", "required": true, - "type": "integer" + "type": "string" }, { "description": "linked domain", @@ -86190,15 +87577,16 @@ "type": "uuid" }, { - "description": "Hostname", + "description": "Port", "length": 255, - "name": "hostname", + "name": "port", "required": true, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + {}, {}, { "description": "linked domain", @@ -86206,26 +87594,25 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "port teh ldap server is running on", "name": "port", "type": "int" }, - { - "description": "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, @@ -86235,39 +87622,39 @@ "name": "ldapConfig", "params": [ { - "description": "Enter the path to trust certificates store.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "truststore", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "hostname", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "binddn", + "name": "truststore", "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" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "ssl", + "name": "hostname", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Enter the password for trust store.", @@ -86284,18 +87671,18 @@ "type": "boolean" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "searchbase", + "name": "queryfilter", "required": false, "type": "string" }, { - "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.", @@ -86307,29 +87694,25 @@ ], "related": "ldapRemove", "response": [ - { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" - }, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", "name": "searchbase", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { @@ -86337,22 +87720,26 @@ "name": "queryfilter", "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": "DN password", "name": "bindpass", "type": "string" }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -86374,40 +87761,40 @@ "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", "type": "string" }, - {}, { - "description": "the ID of the Storage Policy", - "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", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the ID of the Storage Policy", + "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 Storage Policy", + "name": "description", + "type": "string" }, {}, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" } ] @@ -86421,34 +87808,34 @@ "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", - "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" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -86457,11 +87844,12 @@ "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", + "description": "vpc offering ID", "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { "description": "the ID of the vpc", @@ -86472,12 +87860,11 @@ "type": "uuid" }, { - "description": "vpc offering ID", + "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": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "name": "tiernetworkofferings", + "required": false, + "type": "map" }, { "description": "true if previous network migration cmd failed", @@ -86490,115 +87877,39 @@ "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": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, + {}, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { @@ -86607,55 +87918,40 @@ "type": "boolean" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, + {}, { "description": "the cidr the VPC", "name": "cidr", "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 owner of the VPC", - "name": "account", - "type": "string" - }, - {}, { "description": "is vpc for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "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": "Base64 string representation of the resource icon", @@ -86663,96 +87959,192 @@ "type": "resourceiconresponse" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ { "description": "tag value", "name": "value", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { "description": "resource type", "name": "resourcetype", "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "list" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "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 id of the VPC", + "name": "id", + "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { "description": "the name of the VPC", "name": "name", "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" } ], "since": "4.11.0" @@ -86772,12 +88164,6 @@ } ], "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", @@ -86788,11 +88174,17 @@ "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" }, + {}, {} ] }, @@ -86818,24 +88210,19 @@ ], "related": "removeAnnotation", "response": [ - { - "description": "the type of the annotated entity", - "name": "entitytype", - "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", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "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" }, { @@ -86844,41 +88231,46 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "True if the annotation is available for admins only", "name": "adminsonly", "type": "boolean" }, - {}, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + {}, { "description": "the contents of the annotation", "name": "annotation", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", + "type": "string" } ], "since": "4.16" @@ -86888,6 +88280,13 @@ "isasync": false, "name": "listBigSwitchBcfDevices", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the Physical Network ID", "length": 255, @@ -86896,6 +88295,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "bigswitch BCF controller device ID", "length": 255, @@ -86910,78 +88316,127 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ + { + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "device name", "name": "bigswitchdevicename", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the controller username", + "name": "username", + "type": "string" + }, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, { "description": "name of the provider", "name": "provider", "type": "string" }, - {}, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the controller Ip address", "name": "hostname", "type": "string" }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" }, + { + "description": "HA provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "disableHAForHost", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the controller username", - "name": "username", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + {}, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + } ], - "since": "4.6.0" + "since": "4.11" }, { "description": "Updates a configuration.", @@ -86989,10 +88444,10 @@ "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" }, { @@ -87004,18 +88459,18 @@ "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 Domain to update the parameter value for corresponding domain", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -87028,51 +88483,42 @@ "type": "uuid" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the value of the configuration", + "length": 4095, + "name": "value", + "required": false, "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 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 value of the configuration", - "name": "id", - "type": "long" - }, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", "name": "scope", @@ -87080,8 +88526,8 @@ }, {}, { - "description": "the name of the configuration", - "name": "name", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -87089,81 +88535,27 @@ "name": "description", "type": "string" }, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, - {}, - { - "description": "the value of the configuration", - "name": "value", - "type": "string" - } - ] - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "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 category of the configuration", + "name": "category", "type": "string" }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "true if the configuration is dynamic", + "name": "isdynamic", "type": "boolean" } - ], - "since": "4.11" + ] }, { "description": "Dedicates a Public IP range to an account", @@ -87178,14 +88570,6 @@ "required": true, "type": "uuid" }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, { "description": "domain ID of the account owning a VLAN", "length": 255, @@ -87194,6 +88578,14 @@ "required": true, "type": "uuid" }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "account who will own the VLAN", "length": 255, @@ -87205,49 +88597,48 @@ "related": "", "response": [ { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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 ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { @@ -87256,79 +88647,85 @@ "type": "boolean" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "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 ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, - {}, { "description": "the gateway of IPv6 network", "name": "ip6gateway", "type": "string" }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the domain ID of the VLAN IP range", "name": "domainid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the 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 project id of the vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ] @@ -87338,6 +88735,13 @@ "isasync": false, "name": "createProjectRolePermission", "params": [ + { + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "ID of project where project role permission is to be created", "length": 255, @@ -87353,13 +88757,6 @@ "required": true, "type": "string" }, - { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The rule permission, allow or deny. Default: deny.", "length": 255, @@ -87380,49 +88777,49 @@ "response": [ {}, { - "description": "the description of the role permission", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, - {}, { "description": "the ID of the project", "name": "projectid", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, { "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", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } ], @@ -87433,13 +88830,6 @@ "isasync": false, "name": "listRegisteredServicePackages", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -87453,19 +88843,27 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -87473,15 +88871,14 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "Service Package Name", - "name": "name", + "description": "Description of Service Package", + "name": "description", "type": "string" } ] @@ -87492,11 +88889,12 @@ "name": "updateProjectRolePermission", "params": [ { - "description": "Rule permission, can be: allow or deny", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "permission", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" }, { "description": "ID of the project role", @@ -87506,6 +88904,13 @@ "required": true, "type": "uuid" }, + { + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, + "type": "string" + }, { "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, @@ -87514,14 +88919,6 @@ "required": false, "type": "list" }, - { - "description": "ID of project where project role permission is to be updated", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, { "description": "Project Role permission rule id", "length": 255, @@ -87532,6 +88929,11 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -87543,17 +88945,12 @@ "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.15.0" }, @@ -87563,11 +88960,12 @@ "name": "enableStaticNat", "params": [ { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", "length": 255, - "name": "vmguestip", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the virtual machine for enabling static NAT feature", @@ -87586,37 +88984,36 @@ "type": "uuid" }, { - "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)", + "description": "VM guest NIC secondary IP address for the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "vmguestip", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -87635,27 +89032,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -87678,13 +89075,6 @@ "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, @@ -87693,6 +89083,13 @@ "required": false, "type": "uuid" }, + { + "description": "Project role type to be assigned to the user - Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, { "description": "Name of the user to be added to the project", "length": 255, @@ -87702,27 +89099,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" } ], "since": "4.14" @@ -87742,18 +89139,17 @@ } ], "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -87763,7 +89159,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.11" }, @@ -87784,101 +89181,39 @@ "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the 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 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 availablility zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the name of the virtual machine", @@ -87886,63 +89221,53 @@ "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", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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" }, { @@ -87954,24 +89279,29 @@ "name": "value", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -87980,13 +89310,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -87995,28 +89320,17 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "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": "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.", @@ -88024,23 +89338,23 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the 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 ID of the host for the virtual machine", - "name": "hostid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -88049,329 +89363,164 @@ "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": "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "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 state of the virtual machine", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "ID of the 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", + "description": "the type of the affinity group", "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", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "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", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the description of the affinity group", + "name": "description", "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": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -88380,18 +89529,18 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the 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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -88399,13 +89548,18 @@ "name": "icmptype", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -88414,38 +89568,38 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -88457,27 +89611,67 @@ "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -88488,18 +89682,18 @@ "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": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -88508,67 +89702,42 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "account owning the security group rule", @@ -88579,6 +89748,11 @@ "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" @@ -88588,48 +89762,38 @@ "name": "project", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "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": "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" }, { @@ -88638,100 +89802,333 @@ "type": "string" }, { - "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", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - {}, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the speed of each cpu", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the 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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + {}, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the 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": "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" } ] @@ -88742,63 +90139,42 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "the name of the volume/template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "passwordenabled", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "ispublic", + "name": "sshkeyenabled", "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": "Upload volume/template for the project", "length": 255, - "name": "bits", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" }, - { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" - }, { "description": "Template details in key/value pairs.", "length": 255, @@ -88807,98 +90183,119 @@ "type": "map" }, { - "description": "true if this template requires HVM", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "requireshvm", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "the tag for this template.", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "templatetag", + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "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" }, { - "description": "Upload volume/template for the project", + "description": "the target hypervisor for the template", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "sshkeyenabled", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "isextractable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the 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": "an optional accountName. Must be used with domainId.", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "account", + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", "required": false, "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "deployasis", + "name": "ispublic", "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": "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": "isdynamicallyscalable", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the tag for this template.", "length": 255, - "name": "isrouting", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if this template requires HVM", "length": 255, - "name": "isfeatured", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" + }, + { + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" } ], "related": "getUploadParamsForIso", @@ -88908,9 +90305,10 @@ "name": "expires", "type": "string" }, + {}, { - "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" }, { @@ -88918,30 +90316,69 @@ "name": "metadata", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 template/volume ID", "name": "id", "type": "uuid" + } + ], + "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": "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": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.6.0" + "since": "4.17.0" }, { "description": "Release the dedication for host", @@ -88952,12 +90389,19 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "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", @@ -88968,17 +90412,10 @@ "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" } ] }, @@ -88987,13 +90424,6 @@ "isasync": true, "name": "updateProjectInvitation", "params": [ - { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "id of the project to join", "length": 255, @@ -89017,6 +90447,13 @@ "required": false, "type": "string" }, + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "if true, accept the invitation, decline if false. True by default", "length": 255, @@ -89027,26 +90464,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "3.0.0" @@ -89067,76 +90504,34 @@ ], "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", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, { "description": "type of the disk volume", "name": "volumetype", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -89144,107 +90539,149 @@ "name": "jobid", "type": "string" }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, { "description": "name of the snapshot", "name": "name", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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": "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "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": "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": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, { "description": "the type of the snapshot", "name": "snapshottype", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" } ] }, @@ -89253,6 +90690,13 @@ "isasync": false, "name": "listRegions", "params": [ + { + "description": "List Region by region name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -89274,13 +90718,6 @@ "required": false, "type": "integer" }, - { - "description": "List Region by region name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -89292,58 +90729,102 @@ "related": "addRegion", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, { "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the name of the region", "name": "name", "type": "string" + } + ] + }, + { + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", + "params": [ + { + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + }, + { + "description": "the ID of the internal lb provider", + "length": 255, + "name": "id", + "related": "configureInternalLoadBalancerElement", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", + "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": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" - } - ] + }, + {}, + {} + ], + "since": "4.2.0" }, { "description": "Attempts Migration of a system virtual machine to the host specified.", "isasync": true, "name": "migrateSystemVm", "params": [ - { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.16.0", - "type": "uuid" - }, { "description": "the ID of the virtual machine", "length": 255, @@ -89356,8 +90837,17 @@ "description": "destination Host ID to migrate VM to", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "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, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.16.0", "type": "uuid" }, { @@ -89372,94 +90862,103 @@ "related": "", "response": [ { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, - {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the Zone ID for the system VM", + "name": "zoneid", "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": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, { "description": "the gateway for the system VM", "name": "gateway", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "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 host ID for the system VM", - "name": "hostid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, {}, @@ -89469,38 +90968,23 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -89509,39 +90993,40 @@ "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the state of the system VM", - "name": "state", + "description": "guest vlan range", + "name": "guestvlan", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { "description": "the second DNS for the system VM", @@ -89549,23 +91034,28 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain for the system VM", + "name": "networkdomain", + "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": "guest vlan range", - "name": "guestvlan", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" } ] @@ -89582,6 +91072,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "Source of the counter.", "length": 255, @@ -89589,6 +91086,14 @@ "required": false, "type": "string" }, + { + "description": "ID of the Counter.", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -89602,33 +91107,19 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "ID of the Counter.", - "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "required": false, - "type": "uuid" } ], "related": "createCounter", "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": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Source of the counter.", + "name": "source", "type": "string" }, {}, @@ -89638,9 +91129,9 @@ "type": "string" }, { - "description": "Name of the counter.", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "zone id of counter", @@ -89648,70 +91139,16 @@ "type": "string" }, { - "description": "Source of the counter.", - "name": "source", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ] - }, - { - "description": "Configures an Internal Load Balancer element.", - "isasync": true, - "name": "configureInternalLoadBalancerElement", - "params": [ - { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, - { - "description": "the ID of the internal lb provider", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", - "required": true, - "type": "uuid" - } - ], - "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", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "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", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" } - ], - "since": "4.2.0" + ] }, { "description": "Lists all available virtual router elements.", @@ -89719,16 +91156,16 @@ "name": "listVirtualRouterElements", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -89740,13 +91177,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,30 +91191,42 @@ "related": "listVirtualRouterElements", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, {}, {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { @@ -89793,29 +91235,24 @@ "type": "boolean" }, { - "description": "the domain ID associated with the provider", - "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 account associated with the provider", + "name": "account", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { "description": "the id of the router", "name": "id", "type": "string" - }, - { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" } ] }, @@ -89842,28 +91279,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", + "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": "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" - } + }, + {} ] }, { @@ -89872,30 +91309,30 @@ "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" }, { - "description": "", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "pagesize", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "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" } @@ -89908,12 +91345,6 @@ "type": "string" }, {}, - { - "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", @@ -89923,6 +91354,12 @@ "description": "network traffic type", "name": "traffictype", "type": "string" + }, + {}, + { + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", + "type": "string" } ], "since": "3.0.0" @@ -89945,14 +91382,7 @@ "length": 255, "name": "accounttype", "required": true, - "type": "short" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, - "type": "string" + "type": "integer" }, { "description": "type of the ldap name. GROUP or OU, defaults to GROUP", @@ -89974,54 +91404,133 @@ "name": "admin", "required": false, "type": "string" + }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "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": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, - {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "name", "type": "string" }, - {}, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "short" + "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": "name of the group or OU in LDAP which is linked to the domain", "name": "ldapdomain", "type": "string" }, + {}, + { + "description": "Domain Admin accountId that is created", + "name": "accountid", + "type": "string" + }, + {}, { "description": "type of the name in LDAP which is linke to the domain", "name": "type", "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "list the db hosts and statistics", + "isasync": false, + "name": "listDbMetrics", + "params": [], + "related": "", + "response": [ + {}, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" + }, + { + "description": "the version of the currently running DB", + "name": "versioncomment", + "type": "string" + }, + { + "description": "the version of the currently running DB", + "name": "version", + "type": "string" + }, + { + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "int" + }, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "int" + }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" } ], - "since": "4.11.0" + "since": "4.17.0" }, { "description": "Deletes an image store or Secondary Storage.", @@ -90038,28 +91547,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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.2.0" }, @@ -90069,52 +91578,46 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "otherdeployparams", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the autoscale vm profile", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "name": "zoneid", + "related": "createZone,listZones", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the templateid of the autoscale vm profile", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "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", @@ -90122,29 +91625,27 @@ "type": "uuid" }, { - "description": "list profiles by service offering id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "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.", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "account", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -90153,13 +91654,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, @@ -90168,26 +91662,50 @@ "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": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "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 name of the vm profile", + "name": "domain", "type": "string" }, - {}, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "string" }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", @@ -90200,63 +91718,54 @@ "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain ID of the vm profile", + "name": "domainid", "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 template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, + {}, + {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the account owning the instance group", + "name": "account", "type": "string" }, - {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, { "description": "the ID of the user used to launch and destroy the VMs", "name": "autoscaleuserid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the autoscale vm profile ID", "name": "id", "type": "string" }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - } + {} ] }, { @@ -90268,7 +91777,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } @@ -90276,13 +91785,8 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -90291,8 +91795,18 @@ "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { @@ -90300,45 +91814,40 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - {}, { "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 operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, {} @@ -90354,66 +91863,57 @@ "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 host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "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 host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { @@ -90421,30 +91921,83 @@ "name": "disconnected", "type": "date" }, - {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "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 no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -90453,120 +92006,144 @@ "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the cluster name of the host", + "name": "clustername", "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 OS category name of the host", - "name": "oscategoryname", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "the amount of the host's memory currently used", @@ -90574,149 +92151,81 @@ "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "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" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's 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", - "type": "string" - }, { "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "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 Zone name of the host", - "name": "zonename", + "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", - "name": "cpuallocated", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, { "description": "the Zone ID of the host", "name": "zoneid", @@ -90731,18 +92240,18 @@ "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": "error code for this icmp message", "length": 255, - "name": "protocol", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "end port for this ingress rule", + "description": "user to security group mapping", "length": 255, - "name": "endport", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", @@ -90752,34 +92261,33 @@ "type": "list" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "end port for this ingress rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "user to security group mapping", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "usersecuritygrouplist", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, - "type": "map" + "type": "uuid" }, { "description": "an optional project of the security group", @@ -90790,30 +92298,31 @@ "type": "uuid" }, { - "description": "type of the icmp message being sent", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "start port for this ingress rule", "length": 255, - "name": "account", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "securitygroupname", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "error code for this icmp message", + "description": "type of the icmp message being sent", "length": 255, - "name": "icmpcode", + "name": "icmptype", "required": false, "type": "integer" } @@ -90821,8 +92330,23 @@ "related": "", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -90830,13 +92354,13 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -90845,28 +92369,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -90875,43 +92399,24 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, + {}, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -90919,8 +92424,13 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -90928,10 +92438,9 @@ "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" } ] @@ -90953,79 +92462,63 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "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", + "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 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 host's currently used disk size", - "name": "disksizeused", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, { "description": "the storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { @@ -91034,39 +92527,45 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool type", + "name": "type", "type": "string" }, + {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "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 name of the storage pool", - "name": "name", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -91074,25 +92573,35 @@ "name": "state", "type": "storagepoolstatus" }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "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 storage pool path", + "name": "path", "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" } ], "since": "4.15.1" @@ -91116,6 +92625,14 @@ "required": true, "type": "string" }, + { + "description": "Create security group for project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, @@ -91130,22 +92647,72 @@ "name": "description", "required": false, "type": "string" - }, - { - "description": "Create security group for project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -91162,47 +92729,67 @@ "name": "project", "type": "string" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the security group", - "name": "name", + "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 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", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -91211,13 +92798,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -91231,48 +92818,33 @@ "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", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the 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", @@ -91282,125 +92854,92 @@ "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the account associated with the tag", - "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -91409,23 +92948,23 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -91435,98 +92974,87 @@ "description": "the id of the security group rule", "name": "ruleid", "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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 account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" } ] }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project the network is available for", + "name": "project", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the network ID", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" + }, + { + "description": "the account the network is available for", + "name": "account", + "type": "string" + }, + { + "description": "the name of the domain to which the network belongs", + "name": "domain", + "type": "string" } ], - "since": "4.14.0" + "since": "4.17.0" }, { "description": "Recalculate and update resource count for an account or domain.", @@ -91541,14 +93069,6 @@ "required": false, "type": "uuid" }, - { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - }, { "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, @@ -91562,18 +93082,28 @@ "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, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, + {}, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "the project name for which resource count's are updated", + "name": "project", "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": "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" }, { @@ -91582,8 +93112,13 @@ "type": "string" }, { - "description": "the project name for which resource count's are updated", - "name": "project", + "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", "type": "string" }, { @@ -91596,27 +93131,20 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", - "type": "string" - }, - { - "description": "resource count", - "name": "resourcecount", - "type": "long" - }, { "description": "the domain ID for which resource count's are updated", "name": "domainid", "type": "string" }, - {}, - {}, { "description": "the account for which resource count's are updated", "name": "account", "type": "string" + }, + { + "description": "resource count", + "name": "resourcecount", + "type": "long" } ] }, @@ -91634,26 +93162,33 @@ "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 account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "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 objects by project", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { "description": "List by keyword", @@ -91663,20 +93198,19 @@ "type": "string" }, { - "description": "id of vpc", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "id of the vpn gateway", @@ -91687,11 +93221,12 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "id of vpc", "length": 255, - "name": "isrecursive", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -91699,59 +93234,52 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "createVpnGateway", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the vpc id of this gateway", + "name": "vpcid", "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 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 vpn gateway ID", + "name": "id", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { "description": "the vpc name of this gateway", "name": "vpcname", @@ -91763,9 +93291,9 @@ "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { "description": "the public IP address", @@ -91773,9 +93301,9 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -91785,17 +93313,9 @@ "name": "listRoles", "params": [ { - "description": "List role by role ID.", - "length": 255, - "name": "id", - "related": "importRole,listRoles", - "required": false, - "type": "uuid" - }, - { - "description": "List role by role name.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, @@ -91807,44 +93327,57 @@ "type": "integer" }, { - "description": "", + "description": "List role by role ID.", "length": 255, - "name": "page", + "name": "id", + "related": "importRole,listRoles", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "List role by role name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "importRole", "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 type of the role", + "name": "type", "type": "string" }, {}, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -91853,19 +93386,14 @@ "type": "string" }, { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the ID of the role", "name": "id", "type": "string" - }, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "since": "4.9.0" @@ -91886,33 +93414,33 @@ ], "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 user ID for the cloud identifier", "name": "userid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cloud identifier", + "name": "cloudidentifier", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the signed response for the cloud identifier", "name": "signature", "type": "string" }, - { - "description": "the cloud identifier", - "name": "cloudidentifier", - "type": "string" - } + {} ] }, { @@ -91920,6 +93448,13 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API", "length": 255, @@ -91928,11 +93463,12 @@ "type": "string" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "description": "the ID of the load balancer rule", "length": 255, - "name": "param", - "required": false, - "type": "map" + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -91942,39 +93478,32 @@ "since": "4.4", "type": "boolean" }, - { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "name of the load balancer stickiness policy", "length": 255, "name": "name", "required": true, "type": "string" + }, + { + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "length": 255, + "name": "param", + "required": false, + "type": "map" } ], "related": "listLBStickinessPolicies", "response": [ { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, + {}, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { @@ -91982,85 +93511,84 @@ "name": "state", "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 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": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" }, { "description": "the description of the Stickiness policy", "name": "description", "type": "string" }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the LB Stickiness policy ID", "name": "id", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the state of the policy", + "name": "state", "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { "description": "the domain ID of the Stickiness policy", "name": "domainid", "type": "string" }, - {}, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -92077,13 +93605,6 @@ "required": true, "type": "uuid" }, - { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "the Cluster ID", "length": 255, @@ -92098,6 +93619,13 @@ "name": "insideportprofile", "required": true, "type": "string" + }, + { + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" } ], "related": "", @@ -92105,19 +93633,19 @@ {}, {}, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, {} ] }, @@ -92145,18 +93673,8 @@ "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -92165,9 +93683,9 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the public security zone of the external firewall", @@ -92175,13 +93693,13 @@ "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 physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { @@ -92195,47 +93713,57 @@ "type": "long" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "device name", + "name": "fwdevicename", "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" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" - } + }, + { + "description": "the username that's used to log in to the external firewall", + "name": "username", + "type": "string" + }, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + {}, + {} ] }, { @@ -92244,55 +93772,48 @@ "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": "the starting port of ACL", "length": 255, - "name": "customid", + "name": "startport", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "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": "traffictype", + "name": "partialupgrade", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "cidrlist", + "name": "reason", "required": false, - "type": "list" - }, - { - "description": "the ID of the network ACL item", - "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "number", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "reason", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "type of the ICMP message being sent", @@ -92302,116 +93823,164 @@ "type": "integer" }, { - "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", + "name": "protocol", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the network ACL item", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { - "description": "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'.", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "partialupgrade", + "name": "traffictype", "required": false, - "type": "boolean" + "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 ending port of ACL", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "endport", + "name": "number", "required": false, "type": "integer" + }, + { + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" } ], "related": "moveNetworkAclItem", "response": [ - {}, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "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": "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": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { @@ -92419,77 +93988,36 @@ "name": "number", "type": "integer" }, + {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "the 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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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 protocol of the ACL", + "name": "protocol", + "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" } ] }, @@ -92523,23 +94051,23 @@ } ], "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", @@ -92554,78 +94082,87 @@ "name": "listRouters", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the disk router", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "healthchecksfailed", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "the state of the router", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by network id", + "description": "List networks by VPC", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "isrecursive", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "the Pod ID of the router", + "description": "the ID of the disk router", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" }, { - "description": "If set to false, list only 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,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the name of the router", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "list by network id", "length": 255, - "name": "fetchhealthcheckresults", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "list virtual router elements by version", @@ -92643,35 +94180,25 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project", + "description": "the state of the router", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the cluster ID of the router", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "fetchhealthcheckresults", "required": false, - "type": "uuid" + "since": "4.14", + "type": "boolean" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "healthchecksfailed", + "name": "isrecursive", "required": false, - "since": "4.16", "type": "boolean" }, { @@ -92682,85 +94209,92 @@ "type": "string" }, { - "description": "the name of the router", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the host ID of the router", + "description": "the Pod ID of the router", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List networks by VPC", + "description": "the cluster ID of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "the host ID of the router", "length": 255, - "name": "forvpc", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "destroyRouter", "response": [ { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, + {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the template ID for the router", + "name": "templateid", "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": "true if any health checks had failed", + "name": "healthchecksfailed", + "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 ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -92769,58 +94303,53 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "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 IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -92829,48 +94358,48 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "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 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": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -92879,47 +94408,51 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the corresponding network", + "name": "networkid", + "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" } ], "type": "set" }, { - "description": "the name of the router", - "name": "name", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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 name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, - {}, { "description": "the public netmask for the router", "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { @@ -92928,18 +94461,23 @@ "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -92948,49 +94486,54 @@ "type": "boolean" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" }, { "description": "the link local IP address for the router", @@ -92998,28 +94541,33 @@ "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "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 second DNS for the router", - "name": "dns2", + "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 ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -93027,14 +94575,9 @@ "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": "detailed response generated on running health check", @@ -93047,97 +94590,87 @@ "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "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 Pod name for the router", - "name": "podname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, + {}, { "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, - {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" } ] @@ -93151,34 +94684,34 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "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": "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" - } + {} ] }, { @@ -93187,11 +94720,10 @@ "name": "createVpnConnection", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "connection is passive or not", "length": 255, - "name": "fordisplay", + "name": "passive", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -93202,13 +94734,6 @@ "required": true, "type": "uuid" }, - { - "description": "connection is passive or not", - "length": 255, - "name": "passive", - "required": false, - "type": "boolean" - }, { "description": "id of the vpn gateway", "length": 255, @@ -93216,33 +94741,46 @@ "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", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "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": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -93256,18 +94794,8 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -93275,30 +94803,42 @@ "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", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", @@ -93306,29 +94846,33 @@ "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { @@ -93336,26 +94880,15 @@ "name": "passive", "type": "boolean" }, - {}, - { - "description": "the project id", - "name": "projectid", - "type": "string" - }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "State of vpn connection", + "name": "state", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -93364,13 +94897,6 @@ "isasync": false, "name": "listBrocadeVcsDeviceNetworks", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "brocade vcs switch ID", "length": 255, @@ -93379,31 +94905,53 @@ "required": true, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 external id of the network", "name": "externalid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { @@ -93411,169 +94959,162 @@ "name": "subdomainaccess", "type": "boolean" }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, { "description": "zone id of the network", "name": "zoneid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 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": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { "description": "the displaytext of the network", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the 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 network", + "name": "associatednetwork", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - {}, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, - {}, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { "description": "list networks available for vm deployment", @@ -93581,18 +95122,43 @@ "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -93601,18 +95167,33 @@ "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { @@ -93621,18 +95202,100 @@ "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", + "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", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { @@ -93640,27 +95303,44 @@ "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -93669,197 +95349,90 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "type": "list" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the name of the network", - "name": "name", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, { "description": "If the network has redundant routers enabled", "name": "redundantrouter", "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, + "description": "the date this network was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Deletes a Physical Network.", + "isasync": true, + "name": "deletePhysicalNetwork", + "params": [ { - "description": "the network's gateway", - "name": "gateway", + "description": "the ID of the Physical network", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - } - ] - }, - { - "description": "Deletes a Physical Network.", - "isasync": true, - "name": "deletePhysicalNetwork", - "params": [ - { - "description": "the ID of the Physical network", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "response": [ + {}, { "description": "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" }, @@ -93869,18 +95442,18 @@ "name": "dedicateHost", "params": [ { - "description": "the ID of the host to update", + "description": "the ID of the containing domain", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "the ID of the host to update", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" }, @@ -93894,26 +95467,30 @@ ], "related": "listDedicatedHosts", "response": [ - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, - {}, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { @@ -93922,20 +95499,16 @@ "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the domain ID of the host", + "name": "domainid", "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 Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" - } + }, + {} ] }, { @@ -93944,17 +95517,17 @@ "name": "removeVpnUser", "params": [ { - "description": "username for the vpn user", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "username", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "username for the vpn user", "length": 255, - "name": "account", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -93975,17 +95548,6 @@ } ], "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", @@ -93996,6 +95558,17 @@ "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" + }, {} ] }, @@ -94004,14 +95577,6 @@ "isasync": true, "name": "addGloboDnsHost", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "GloboDNS url", "length": 255, @@ -94032,31 +95597,39 @@ "name": "password", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "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.5.0" }, @@ -94067,12 +95640,12 @@ "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", @@ -94102,26 +95675,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ], "since": "4.2.0" @@ -94131,13 +95704,6 @@ "isasync": false, "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", - "length": 255, - "name": "rules", - "required": true, - "type": "map" - }, { "description": "The description of the role", "length": 255, @@ -94146,10 +95712,17 @@ "type": "string" }, { - "description": "Creates a role with this unique name", + "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", "length": 255, - "name": "name", + "name": "rules", "required": true, + "type": "map" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { @@ -94160,29 +95733,35 @@ "type": "boolean" }, { - "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" } ], "related": "", "response": [ { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the description of the role", + "name": "description", + "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the role", @@ -94190,24 +95769,74 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the role", + "name": "type", "type": "string" }, + {}, { "description": "the ID of the role", "name": "id", "type": "string" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ {}, + { + "description": "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" + }, + { + "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": "operation status", + "name": "status", + "type": "boolean" } ], - "since": "4.15.0" + "since": "4.11" }, { "description": "List Swift.", @@ -94215,87 +95844,67 @@ "name": "listSwifts", "params": [ { - "description": "the id of the swift", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "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 protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - {}, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the 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", @@ -94308,73 +95917,37 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "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", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "operation status", - "name": "status", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.11" + "since": "3.0.0" }, { "description": "Enables out-of-band management for a host", @@ -94385,16 +95958,23 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "related": "disableOutOfBandManagementForCluster", "response": [ + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -94402,62 +95982,55 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "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 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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" } ], "since": "4.9.0" @@ -94478,9 +96051,9 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, {}, @@ -94490,9 +96063,9 @@ "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", @@ -94506,6 +96079,13 @@ "isasync": false, "name": "listKubernetesSupportedVersions", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, @@ -94514,10 +96094,10 @@ "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "listKubernetesSupportedVersions", "required": false, "type": "uuid" }, @@ -94530,82 +96110,70 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, {}, - { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "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 minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, - {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "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" }, { @@ -94614,29 +96182,34 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, + { + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, { "description": "the name of the zone in which Kubernetes supported version is available", "name": "zonename", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" } ] }, @@ -94646,9 +96219,9 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Credentials to access the Nicira Controller API", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" }, @@ -94666,6 +96239,13 @@ "required": true, "type": "string" }, + { + "description": "The Transportzone UUID configured on the Nicira Controller", + "length": 255, + "name": "transportzoneuuid", + "required": true, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -94682,182 +96262,67 @@ "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", - "length": 255, - "name": "transportzoneuuid", - "required": true, - "type": "string" - }, - { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" } ], "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", - "type": "string" - }, - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" - }, { "description": "this L3 gateway service Uuid", "name": "l3gatewayserviceuuid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "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, + "description": "the physical network to which this Nirica Nvp belongs to", "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": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "supports only F5BigIpLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, + "description": "device name", + "name": "niciradevicename", "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", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "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", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "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", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {}, + {} ] }, { @@ -94872,17 +96337,10 @@ "required": false, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -94895,40 +96353,43 @@ "type": "uuid" }, { - "description": "", + "description": "list providers by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list providers by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the 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": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -94937,13 +96398,23 @@ "type": "list" }, { - "description": "the provider name", - "name": "name", + "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": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -94951,12 +96422,6 @@ "name": "destinationphysicalnetworkid", "type": "string" }, - {}, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, {} ], "since": "3.0.0" @@ -94969,13 +96434,8 @@ "related": "", "response": [ { - "description": "Number of management servers", - "name": "managementservers", - "type": "integer" - }, - { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of pods", + "name": "pods", "type": "integer" }, { @@ -94984,62 +96444,67 @@ "type": "integer" }, { - "description": "Number of clusters", - "name": "clusters", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, + {}, { - "description": "Number of routers", - "name": "routers", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, {}, { - "description": "Number of pods", - "name": "pods", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" - }, - {} + } ], "since": "4.9.3" }, @@ -95049,99 +96514,99 @@ "name": "listUsageRecords", "params": [ { - "description": "List usage records for the specified account", + "description": "", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "since": "4.15", - "type": "boolean" + "type": "integer" }, { - "description": "List usage records for the specified domain.", + "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "oldformat", + "name": "usageid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "List usage records for the specified usage type", "length": 255, - "name": "keyword", + "name": "type", "required": false, - "type": "string" + "type": "long" }, { - "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", + "description": "List usage records for the specified account", "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "page", + "name": "includetags", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List usage records for the specified user.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List usage records for specified project", + "description": "List usage records for the specified domain.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "usageid", + "name": "oldformat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List usage records for the specified usage type", + "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": "type", + "name": "isrecursive", "required": false, - "type": "long" + "since": "4.15", + "type": "boolean" }, { - "description": "", + "description": "List usage records for the specified user.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "List usage records for specified project", "length": 255, - "name": "includetags", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "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).", @@ -95154,38 +96619,33 @@ "related": "", "response": [ { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the user account name", - "name": "account", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "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": "start date of the usage record", + "name": "startdate", "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "template ID", + "name": "templateid", "type": "string" }, { @@ -95194,13 +96654,29 @@ "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "the user account Id", + "name": "accountid", + "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the project id of the resource", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "virtual machine os type ID", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the domain ID", + "name": "domainid", "type": "string" }, { @@ -95208,99 +96684,114 @@ "name": "isdefault", "type": "boolean" }, - {}, { - "description": "template ID", - "name": "templateid", + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" + }, + { + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", + "description": "offering ID", + "name": "offeringid", "type": "string" }, + { + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, { "description": "resource size", "name": "size", "type": "long" }, { - "description": "offering ID", - "name": "offeringid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", + "description": "resource type", + "name": "type", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "description of the usage record", + "name": "description", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", "type": "boolean" }, { - "description": "usage in hours", - "name": "usage", + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, + {}, + { + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "number of cpu of resource", + "name": "cpunumber", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine os display name", + "name": "osdisplayname", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -95309,32 +96800,22 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "the user account Id", - "name": "accountid", - "type": "string" - }, - { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "virtual machine os category name", @@ -95342,54 +96823,38 @@ "type": "string" }, { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "the domain ID", - "name": "domainid", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" }, { - "description": "start date of the usage record", - "name": "startdate", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - {}, - { - "description": "memory allocated for the resource", - "name": "memory", + "description": "speed of each cpu of resource", + "name": "cpuspeed", "type": "long" }, { - "description": "description of the usage record", - "name": "description", + "description": "end date of the usage record", + "name": "enddate", "type": "string" } ] @@ -95409,23 +96874,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": "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", @@ -95448,27 +96913,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "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" + }, {} ] }, @@ -95489,29 +96954,9 @@ "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": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the virtual machine", @@ -95519,85 +96964,126 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of 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 disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the status of the volume", + "name": "status", "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": "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "the name of the template for the virtual machine", @@ -95605,94 +97091,81 @@ "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", + "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 ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, + {}, + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "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", @@ -95700,38 +97173,43 @@ "type": "date" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "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": "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -95740,136 +97218,128 @@ "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "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 path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, { "description": "size of the disk volume", "name": "size", "type": "long" }, { - "description": "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" } ], @@ -95891,56 +97361,42 @@ ], "related": "createUser,getUser", "response": [ - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, { "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user firstname", + "name": "firstname", "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 boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the user lastname", "name": "lastname", @@ -95948,29 +97404,34 @@ }, {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { "description": "the user ID", @@ -95978,8 +97439,13 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -95987,31 +97453,35 @@ "name": "usersource", "type": "string" }, - {}, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "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" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" } ] }, @@ -96021,26 +97491,41 @@ "name": "listZonesMetrics", "params": [ { - "description": "flag to display the capacity of the zones", + "description": "the ID of the zone", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "keyword", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the domain associated with the zone", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "available", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List zones by resource tags (key/value pairs)", @@ -96058,19 +97543,12 @@ "type": "integer" }, { - "description": "the name of the zone", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "flag to display the resource image for the zones", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, { "description": "the network type of the zone that the virtual machine belongs to", "length": 255, @@ -96086,123 +97564,88 @@ "type": "integer" }, { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "the name of the zone", "length": 255, - "name": "available", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, - {}, { - "description": "Zone description", - "name": "description", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "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": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, - { - "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": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the Zone name", @@ -96210,44 +97653,39 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, { "description": "the Pod ID", "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { "description": "the total capacity available", @@ -96255,36 +97693,36 @@ "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" } ], "type": "list" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -96292,19 +97730,15 @@ "name": "domainname", "type": "string" }, + {}, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { @@ -96316,14 +97750,19 @@ "name": "domainid", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -96336,58 +97775,73 @@ "name": "account", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" } ], "type": "set" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "Zone id", - "name": "id", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "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": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" }, { "description": "the display text of the zone", @@ -96395,34 +97849,39 @@ "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "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": "healthy / total clusters in the zone", "name": "clusters", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "memory usage disable threshold exceeded", @@ -96430,20 +97889,31 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" - } + }, + {} ], "since": "4.9.3" }, @@ -96452,6 +97922,14 @@ "isasync": true, "name": "extractTemplate", "params": [ + { + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, { "description": "the ID of the template", "length": 255, @@ -96467,14 +97945,6 @@ "required": true, "type": "string" }, - { - "description": "the ID of the zone where the ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, { "description": "the url to which the ISO would be extracted", "length": 2048, @@ -96485,14 +97955,15 @@ ], "related": "", "response": [ + {}, { - "description": "", - "name": "resultstring", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { @@ -96506,65 +97977,64 @@ "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, { "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 upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "", + "name": "resultstring", + "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 name of the extracted object", - "name": "name", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the name of the extracted object", + "name": "name", "type": "string" } ] @@ -96584,28 +98054,28 @@ } ], "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest 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" - } + {} ] }, { @@ -96624,65 +98094,35 @@ ], "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", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, {}, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "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 snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { @@ -96690,69 +98130,14 @@ "name": "vmtotal", "type": "long" }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, { "description": "the total memory (in MB) the project can own", "name": "memorylimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { @@ -96760,103 +98145,18 @@ "name": "templatelimit", "type": "string" }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, { "description": "the total number of public ip addresses this project can acquire", "name": "iplimit", "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 number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -96870,8 +98170,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -96884,114 +98184,99 @@ "name": "key", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - {}, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an IP address", - "isasync": true, - "name": "updateIpAddress", - "params": [ + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the ID of the public IP address to update", - "length": 255, - "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "associateIpAddress,listPublicIpAddresses", - "response": [ + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, + {}, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -96999,26 +98284,235 @@ "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the displaytext of the project", + "name": "displaytext", + "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", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates an IP address", + "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": "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 public IP address to update", + "length": 255, + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "related": "associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { "description": "the project name of the address", "name": "project", "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": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, { "description": "the list of resource tags associated with ip address", "name": "tags", @@ -97029,13 +98523,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -97044,13 +98538,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -97059,61 +98553,47 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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" } ], "type": "list" }, { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, + {}, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "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 where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -97121,65 +98601,55 @@ "name": "networkname", "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 account the public IP address is associated with", - "name": "account", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" } ] @@ -97192,31 +98662,31 @@ "related": "", "response": [ { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "the account name of the api remaining count", + "name": "account", + "type": "string" }, {}, - {}, { "description": "the account uuid of the api remaining count", "name": "accountid", "type": "string" }, { - "description": "number of api already issued", - "name": "apiIssued", + "description": "currently allowed number of apis", + "name": "apiAllowed", "type": "int" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" }, { "description": "seconds left to reset counters", @@ -97224,9 +98694,9 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -97245,27 +98715,27 @@ } ], "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -97276,11 +98746,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,302 +98762,277 @@ "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", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "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", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "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": "state of the network", + "name": "state", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "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": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "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 details of the network", - "name": "details", - "type": "map" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the domain id of the network owner", + "name": "domainid", "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 project id of the ipaddress", - "name": "projectid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { @@ -97595,136 +99041,200 @@ "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the owner of the network", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, { "description": "The external id of the network", "name": "externalid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of services", + "name": "service", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11.0" @@ -97743,17 +99253,17 @@ "type": "uuid" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "The password for specified username.", "length": 255, - "name": "vcenter", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "The password for specified username.", + "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": "password", - "required": false, + "name": "vcenter", + "required": true, "type": "string" }, { @@ -97773,172 +99283,339 @@ ], "related": "", "response": [ + {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "type": "string" - }, { "description": "The VMware Datacenter ID", "name": "id", "type": "string" }, - {} + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + } ] }, { - "description": "Lists unmanaged virtual machines for a given cluster.", - "isasync": false, - "name": "listUnmanagedInstances", + "description": "Updates Ipv6 firewall rule with specified ID", + "isasync": true, + "name": "updateIpv6FirewallRule", "params": [ { - "description": "", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "page", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "List by keyword", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "keyword", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the hypervisor name of the instance", + "description": "error code for this ICMP message", "length": 255, - "name": "name", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "pagesize", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the cluster ID", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "id", + "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 memory of the virtual machine in MB", - "name": "memory", + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, "type": "integer" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the 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": "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": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the 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 ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the 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 id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag value", + "name": "value", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + } + ] + }, + { + "description": "Lists unmanaged virtual machines for a given cluster.", + "isasync": false, + "name": "listUnmanagedInstances", + "params": [ + { + "description": "the hypervisor name of the instance", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "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": "", + "response": [ + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "the gateway of the nic", @@ -97946,30 +99623,45 @@ "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "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", @@ -97981,114 +99673,99 @@ "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "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", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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", + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "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 CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the CPU cores per socket for the virtual machine. VMware specific", @@ -98096,8 +99773,8 @@ "type": "integer" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -98106,17 +99783,82 @@ "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "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 list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + } + ], + "type": "set" + } ], "since": "4.14.0" }, @@ -98126,26 +99868,19 @@ "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", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isfeatured", + "name": "projectids", + "related": "activateProject", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "permission operator (add, remove, reset)", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "op", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", @@ -98155,19 +99890,19 @@ "type": "list" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "projectids", - "related": "activateProject", + "name": "op", "required": false, - "type": "list" + "type": "string" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "the template ID", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", @@ -98175,31 +99910,38 @@ "name": "isextractable", "required": false, "type": "boolean" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" } ], "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "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" + } ] }, { @@ -98208,47 +99950,40 @@ "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.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "directdownload", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "deployasis", + "name": "isfeatured", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrouting", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", @@ -98259,52 +99994,53 @@ "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "passwordenabled", + "name": "sshkeyenabled", "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": "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": "the name of the template", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "details", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isdynamicallyscalable", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", "length": 255, - "name": "sshkeyenabled", + "name": "zoneids", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "isfeatured", + "name": "isrouting", "required": false, "type": "boolean" }, @@ -98316,19 +100052,26 @@ "type": "integer" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "the tag for this template.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the target hypervisor for the template", + "description": "Register template for the project", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" }, { "description": "true if the template is available to all accounts; default is true", @@ -98338,224 +100081,218 @@ "type": "boolean" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", "required": true, "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "isextractable", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "requireshvm", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Register template for the project", + "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": "projectid", - "related": "activateProject", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" } ], "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the template name", - "name": "name", - "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", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the 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": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { "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 template ID", + "name": "id", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the tag of this template", + "name": "templatetag", + "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 this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, - {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "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": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -98563,23 +100300,23 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project 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" }, { @@ -98588,71 +100325,81 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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" } ], "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -98661,38 +100408,33 @@ "type": "set" }, { - "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", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" } ] @@ -98712,13 +100454,12 @@ } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -98729,6 +100470,7 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -98741,6 +100483,13 @@ "isasync": false, "name": "addStratosphereSsp", "params": [ + { + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, { "description": "stratosphere ssp server url", "length": 255, @@ -98749,16 +100498,16 @@ "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "stratosphere ssp tenant uuid", "length": 255, - "name": "password", + "name": "tenantuuid", "required": false, "type": "string" }, { - "description": "stratosphere ssp api username", + "description": "stratosphere ssp api password", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, @@ -98770,13 +100519,6 @@ "required": true, "type": "uuid" }, - { - "description": "stratosphere ssp tenant uuid", - "length": 255, - "name": "tenantuuid", - "required": false, - "type": "string" - }, { "description": "stratosphere ssp api name", "length": 255, @@ -98792,28 +100534,28 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "zone which this ssp controls", + "name": "zoneid", + "type": "string" + }, { "description": "url of ssp endpoint", "name": "url", "type": "string" }, - {}, { "description": "server id of the stratosphere ssp server", "name": "hostid", "type": "string" }, - {}, { "description": "name", "name": "name", "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", @@ -98836,23 +100578,23 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -98866,34 +100608,33 @@ "name": "createStoragePool", "params": [ { - "description": "the storage provider name", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "capacityiops", + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "url", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "the storage provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { "description": "the name for the storage pool", @@ -98903,11 +100644,12 @@ "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "tags", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" }, { "description": "whether the storage should be managed by CloudStack", @@ -98917,17 +100659,10 @@ "type": "boolean" }, { - "description": "the details for the storage pool", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "details", + "name": "scope", "required": false, - "type": "map" - }, - { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": true, "type": "string" }, { @@ -98945,88 +100680,89 @@ "type": "string" }, { - "description": "the cluster ID for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "capacityiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the scope of the storage: cluster or zone", + "description": "the details for the storage pool", "length": 255, - "name": "scope", + "name": "details", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - {}, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -99034,54 +100770,65 @@ "name": "allocatediops", "type": "long" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "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 tags for the storage pool", - "name": "tags", - "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 IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { "description": "the storage pool path", "name": "path", "type": "string" }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, { "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -99090,18 +100837,13 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" } ] @@ -99111,13 +100853,6 @@ "isasync": false, "name": "findStoragePoolsForMigration", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -99125,6 +100860,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -99133,40 +100876,39 @@ "type": "integer" }, { - "description": "the ID of the volume", + "description": "", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "the scope of the storage pool", @@ -99174,106 +100916,101 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "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 Zone name of the storage pool", + "name": "zonename", "type": "string" }, + {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, + {}, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { "description": "the IP address of the storage pool", @@ -99281,9 +101018,14 @@ "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the storage pool", + "name": "name", "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" } ] }, @@ -99292,6 +101034,13 @@ "isasync": true, "name": "addOpenDaylightController", "params": [ + { + "description": "Username to access the OpenDaylight API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -99307,13 +101056,6 @@ "required": true, "type": "string" }, - { - "description": "Username to access the OpenDaylight API", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "Api URL of the OpenDaylight Controller.", "length": 255, @@ -99324,43 +101066,43 @@ ], "related": "", "response": [ - { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the name assigned to the controller", - "name": "name", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of the controller", - "name": "id", + "description": "the url of the controller api", + "name": "url", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the username to authenticate to the controller", "name": "username", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "device id of the controller", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, - {} + {}, + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" + } ] }, { @@ -99369,9 +101111,16 @@ "name": "createZone", "params": [ { - "description": "network type of the zone, can be Basic or Advanced", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "networktype", + "name": "internaldns2", + "required": false, + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", "required": true, "type": "string" }, @@ -99384,265 +101133,232 @@ "type": "uuid" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "the second DNS for the Zone", "length": 255, - "name": "securitygroupenabled", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "guestcidraddress", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "localstorageenabled", + "name": "domain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "ip6dns2", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "ip6dns1", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "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" }, { - "description": "the second DNS for the Zone", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "dns2", + "name": "securitygroupenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the second internal DNS for the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "internaldns2", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "dns1", + "name": "name", "required": true, "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "allocationstate", - "required": false, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "domain", + "name": "ip6dns1", "required": false, "type": "string" - }, - { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listZones", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone id", + "name": "id", + "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" - }, - { - "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 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": "Zone name", - "name": "name", - "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" + "type": "set" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Zone description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -99651,69 +101367,95 @@ "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, { "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "Zone id", - "name": "id", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "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 guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, {}, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { @@ -99740,19 +101482,20 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, + {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "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": "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", @@ -99760,40 +101503,39 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" }, { - "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 id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "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" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { @@ -99807,9 +101549,9 @@ "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" } ] }, @@ -99819,39 +101561,32 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "the netmask for storage network", + "description": "the beginning IP address", "length": 255, - "name": "netmask", + "name": "startip", "required": true, "type": "string" }, { - "description": "the beginning IP address", + "description": "the gateway for storage network", "length": 255, - "name": "startip", + "name": "gateway", "required": true, "type": "string" }, { - "description": "the gateway for storage network", + "description": "the netmask for storage network", "length": 255, - "name": "gateway", + "name": "netmask", "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", @@ -99860,13 +101595,25 @@ "related": "updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "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", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" } ], "related": "", "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 end ip of the storage network IP range", + "name": "endip", "type": "string" }, { @@ -99879,31 +101626,22 @@ "name": "gateway", "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 uuid of storage network IP range.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { "description": "the Pod uuid for the storage network IP range", @@ -99915,7 +101653,11 @@ "name": "networkid", "type": "string" }, - {}, + { + "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", @@ -99930,11 +101672,11 @@ "name": "listDomainChildren", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list children domain by parent domain ID.", @@ -99952,37 +101694,37 @@ "type": "boolean" }, { - "description": "list children domains by name", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "list children domains by name", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" } @@ -99990,184 +101732,181 @@ "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": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { "description": "the ID of the domain", "name": "id", "type": "string" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "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 domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "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 primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { "description": "the total number of cpu cores available to be created for this domain", @@ -100175,75 +101914,78 @@ "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, - {}, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "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 primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" } ] @@ -100264,23 +102006,23 @@ ], "related": "", "response": [ - {}, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", + "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 base64 encoded encrypted password of the VM", + "name": "encryptedpassword", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -100313,18 +102055,12 @@ } ], "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", @@ -100334,6 +102070,12 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -100342,13 +102084,6 @@ "isasync": true, "name": "configureOvsElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the ovs provider", "length": 255, @@ -100356,40 +102091,57 @@ "related": "configureOvsElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, {}, {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -100397,20 +102149,10 @@ "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 id of the ovs", - "name": "id", - "type": "string" } ] }, @@ -100420,18 +102162,18 @@ "name": "addImageStoreS3", "params": [ { - "description": "Name of the storage bucket", + "description": "S3 endpoint", "length": 255, - "name": "bucket", + "name": "endpoint", "required": true, "type": "string" }, { - "description": "S3 endpoint", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "endpoint", - "required": true, - "type": "string" + "name": "connectiontimeout", + "required": false, + "type": "integer" }, { "description": "Whether TCP keep-alive is used", @@ -100448,11 +102190,11 @@ "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "S3 secret key", "length": 255, - "name": "usehttps", - "required": false, - "type": "boolean" + "name": "secretkey", + "required": true, + "type": "string" }, { "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", @@ -100461,6 +102203,13 @@ "required": false, "type": "string" }, + { + "description": "Connection TTL (milliseconds)", + "length": 255, + "name": "connectionttl", + "required": false, + "type": "integer" + }, { "description": "Maximum number of times to retry on error", "length": 255, @@ -100469,18 +102218,18 @@ "type": "integer" }, { - "description": "S3 secret key", + "description": "Name of the storage bucket", "length": 255, - "name": "secretkey", + "name": "bucket", "required": true, "type": "string" }, { - "description": "Connection TTL (milliseconds)", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "connectionttl", + "name": "usehttps", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "Socket timeout (milliseconds)", @@ -100488,72 +102237,46 @@ "name": "sockettimeout", "required": false, "type": "integer" - }, - { - "description": "Connection timeout (milliseconds)", - "length": 255, - "name": "connectiontimeout", - "required": false, - "type": "integer" } ], "related": "listImageStores", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + {}, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "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 provider name of the image store", @@ -100561,15 +102284,34 @@ "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.7.0" @@ -100580,24 +102322,10 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Hypervisor type", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "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" }, @@ -100609,6 +102337,20 @@ "required": true, "type": "uuid" }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Hypervisor type", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "SSL certificate", "length": 65535, @@ -100617,28 +102359,74 @@ "type": "string" } ], + "related": "", "response": [ + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "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 name where the certificate is uploaded", + "name": "zonename", + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the direct download certificate version", + "name": "version", + "type": "string" } ], "since": "4.11.0" @@ -100649,18 +102437,11 @@ "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": "the display name of the instance", "length": 255, - "name": "nicipaddresslist", + "name": "displayname", "required": false, - "type": "map" + "type": "string" }, { "description": "the cluster ID", @@ -100670,14 +102451,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" - }, { "description": "used to specify the custom parameters.", "length": 255, @@ -100686,47 +102459,41 @@ "type": "map" }, { - "description": "import instance to the domain specified", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the display name of the instance", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "displayname", + "name": "account", "required": false, "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "VM is imported despite some of its NIC's MAC addresses are already present", "length": 255, - "name": "migrateallowed", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" - }, - { - "description": "VM is imported despite some of its NIC's MAC addresses are already present", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "import instance to the domain specified", "length": 255, - "name": "nicnetworklist", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "map" + "type": "uuid" }, { "description": "the host name of the instance", @@ -100736,18 +102503,10 @@ "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the hypervisor name of the instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", "required": true, - "type": "uuid" - }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, "type": "string" }, { @@ -100757,142 +102516,236 @@ "related": "activateProject", "required": false, "type": "uuid" - } - ], - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ + }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + } + ], + "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 project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of 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 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", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "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 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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { "description": "true if high-availability is enabled, false otherwise", @@ -100900,9 +102753,24 @@ "type": "boolean" }, { - "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 template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "Guest vm Boot Type", @@ -100910,14 +102778,176 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the 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": "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { "description": "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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 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", @@ -100942,29 +102972,14 @@ "name": "endport", "type": "integer" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -100972,112 +102987,102 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -101086,8 +103091,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -101101,23 +103111,18 @@ "type": "string" }, { - "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": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -101129,14 +103134,9 @@ "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the protocol of the security group rule", @@ -101144,117 +103144,217 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "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 project name of the group", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "Vm details in key/value pairs.", @@ -101262,38 +103362,91 @@ "type": "map" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -101302,455 +103455,310 @@ "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "the ID of the virtual machine", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", + "params": [ + { + "description": "the ID of the IPv6 firewall rule", + "length": 255, "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Creates a physical network", + "isasync": true, + "name": "createPhysicalNetwork", + "params": [ { - "description": "the ID of the availablility zone for the virtual machine", + "description": "the Zone ID for the physical network", + "length": 255, "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", + "required": false, "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the physical network", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, "type": "string" }, - {}, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "length": 255, + "name": "isolationmethods", + "required": false, + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "domain ID of the account owning a physical network", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the speed of the physical network", + "name": "networkspeed", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "state of the physical network", + "name": "state", "type": "string" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the uuid of the physical network", + "name": "id", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "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": "the state of the virtual machine", - "name": "state", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "name of the physical network", + "name": "name", "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", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "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" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Lists autoscale vm groups.", + "isasync": false, + "name": "listAutoScaleVmGroups", + "params": [ { - "description": "the account associated with the virtual machine", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the profile", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", + "required": false, + "type": "uuid" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the 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", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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 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 gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the autoscale vm group", + "length": 255, + "name": "id", + "related": "listAutoScaleVmGroups", + "required": false, + "type": "uuid" }, { - "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", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the physical network", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "broadcastdomainrange", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "the ID of the loadbalancer", "length": 255, - "name": "networkspeed", + "name": "lbruleid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "domain ID of the account owning a physical network", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -101758,145 +103766,164 @@ "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the availability zone ID", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "the ID of the policy", "length": 255, - "name": "isolationmethods", + "name": "policyid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the VLAN for the physical network", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "vlan", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, {}, { - "description": "state of the physical network", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the physical network", - "name": "name", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, {}, { - "description": "the speed of the physical network", - "name": "networkspeed", + "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 load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the domain id of the physical network owner", - "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" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists autoscale vm groups.", - "isasync": false, - "name": "listAutoScaleVmGroups", + "description": "Creates a firewall rule for a given IP address", + "isasync": true, + "name": "createFirewallRule", "params": [ { - "description": "the ID of the autoscale vm group", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", - "required": false, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "list objects by project", + "description": "type of the ICMP message being sent", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "icmptype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "error code for this icmp message", "length": 255, - "name": "pagesize", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the ID of the profile", + "description": "type of firewallrule: system/user", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -101904,120 +103931,47 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "account", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of the loadbalancer", + "description": "the starting port of firewall rule", "length": 255, - "name": "lbruleid", - "related": "", + "name": "startport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the ending port of firewall rule", "length": 255, - "name": "page", + "name": "endport", "required": false, "type": "integer" + } + ], + "related": "updateEgressFirewallRule", + "response": [ + { + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", - "related": "", - "required": false, - "type": "uuid" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "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": "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 frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -102025,116 +103979,41 @@ "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 starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the 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", - "isasync": true, - "name": "createFirewallRule", - "params": [ - { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "type of the ICMP message being sent", - "length": 255, + "description": "type of the icmp message being sent", "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, + "description": "the protocol of the firewall rule", "name": "protocol", - "required": true, "type": "string" }, + {}, { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, - "type": "string" - } - ], - "related": "updateEgressFirewallRule", - "response": [ - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -102142,23 +104021,23 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -102167,83 +104046,42 @@ "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the 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" } ], "type": "list" }, - {}, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { "description": "the ending port of firewall rule's port range", @@ -102251,16 +104089,10 @@ "type": "integer" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - {} + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } ] }, { @@ -102269,19 +104101,19 @@ "name": "createVolume", "params": [ { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "snapshotid", - "related": "", + "name": "customid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the disk volume", + "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": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", @@ -102292,35 +104124,27 @@ "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "snapshotid", + "related": "", "required": false, "type": "uuid" }, { - "description": "max iops", + "description": "Arbitrary volume size", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, - { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, @@ -102329,193 +104153,196 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "max iops", "length": 255, - "name": "customid", + "name": "maxiops", "required": false, - "type": "string" + "type": "long" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "name": "projectid", + "related": "activateProject", "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": "min iops", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "miniops", + "required": false, + "type": "long" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "min iops", + "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", "length": 255, - "name": "miniops", + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Arbitrary volume size", + "description": "the name of the disk volume", "length": 255, - "name": "size", + "name": "name", "required": false, - "type": "long" + "type": "string" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "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 bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "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": "the domain associated with the disk volume", - "name": "domain", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -102524,37 +104351,63 @@ "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -102563,202 +104416,254 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, + {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, - {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "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": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "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": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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": "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": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" + } + ] + }, + { + "description": "List virtual machine snapshot by conditions", + "isasync": false, + "name": "listVMSnapshot", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, - {}, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "length": 255, + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, "name": "domainid", - "type": "string" + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "lists snapshot by snapshot name or display name", + "length": 255, + "name": "name", + "required": false, "type": "string" - } - ] - }, - { - "description": "lists network that are using a F5 load balancer device", - "isasync": false, - "name": "listF5LoadBalancerNetworks", - "params": [ + }, { "description": "", "length": 255, @@ -102767,12 +104672,11 @@ "type": "integer" }, { - "description": "f5 load balancer device ID", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "lbdeviceid", - "related": "", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "type": "string" }, { "description": "List by keyword", @@ -102787,641 +104691,528 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": false, + "type": "uuid" } ], - "related": "createNetwork,updateNetwork,listNetworks", + "related": "createVMSnapshot", "response": [ { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "VM Snapshot type", + "name": "type", + "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "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": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" + "type": "set" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "indiates if this is current snapshot", + "name": "current", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "state of the network", - "name": "state", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The external id of the network", - "name": "externalid", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the domain id of the network owner", + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + } + ], + "since": "4.2.0" + }, + { + "description": "Updates a Pod.", + "isasync": false, + "name": "updatePod", + "params": [ + { + "description": "the netmask of the Pod", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, "type": "string" - }, - {}, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, + } + ], + "related": "createManagementNetworkIpRange", + "response": [ { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "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": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "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", - "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 network domain", - "name": "networkdomain", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", - "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 owner of the network", - "name": "account", - "type": "string" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", - "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 network can span multiple zones", - "name": "strechedl2subnet", - "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 name of the network", - "name": "name", + "description": "the gateway of the Pod", + "name": "gateway", "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 services", - "name": "service", + "description": "the IP ranges for the Pod", + "name": "ipranges", "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": "the starting IP for the range", + "name": "startip", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "the ending IP for the range", + "name": "endip", "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": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "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 domain name of the network owner", - "name": "domain", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" } ] }, { - "description": "List virtual machine snapshot by conditions", - "isasync": false, - "name": "listVMSnapshot", + "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "isasync": true, + "name": "moveNetworkAclItem", "params": [ { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "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": "If set to false, list only 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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": false, - "type": "uuid" - }, - { - "description": "lists snapshot by snapshot name or display name", + "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", "length": 255, - "name": "name", + "name": "aclconsistencyhash", "required": false, "type": "string" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", - "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "required": true, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "account", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "previousaclruleid", "required": false, - "type": "map" + "type": "string" }, { - "description": "state of the virtual machine snapshot", + "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": "state", + "name": "nextaclruleid", "required": false, "type": "string" } ], - "related": "createVMSnapshot", + "related": "", "response": [ { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the name of the vm snapshot", - "name": "name", - "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 project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, + {}, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the network ACLs", "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 domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -103430,167 +105221,58 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, - {}, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates a Pod.", - "isasync": false, - "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", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address for the Pod", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "the ID of the Pod", - "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the gateway for the Pod", - "length": 255, - "name": "gateway", - "required": false, - "type": "string" - }, - { - "description": "the starting IP address for the Pod", - "length": 255, - "name": "startip", - "required": false, + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": false, + "description": "the ending port of ACL's port range", + "name": "endport", "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 UUID of the latest async job acting on this object", @@ -103603,229 +105285,96 @@ "type": "integer" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the ID of the Pod", + "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "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 capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "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": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + } ] }, { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "description": "Attaches an ISO to a virtual machine.", "isasync": true, - "name": "moveNetworkAclItem", + "name": "attachIso", "params": [ { - "description": "The ID of the network ACL rule that is being moved to a new position.", + "description": "the ID of the virtual machine", "length": 255, - "name": "id", + "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": "string" - }, - { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", - "length": 255, - "name": "aclconsistencyhash", - "required": false, - "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "description": "the ID of the ISO file", "length": 255, - "name": "previousaclruleid", - "required": false, - "type": "string" + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, - "name": "nextaclruleid", + "name": "forced", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" } ], - "related": "", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - {}, - {}, - { - "description": "the list of resource tags associated with the network ACLs", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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": "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" }, { @@ -103834,273 +105383,204 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "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": "Attaches an ISO to a virtual machine.", - "isasync": true, - "name": "attachIso", - "params": [ - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" }, + {}, { - "description": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the ID of the availablility zone for the virtual machine", @@ -104108,427 +105588,99 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the 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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the 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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 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 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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the ID of 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 vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, - {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "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", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { @@ -104536,59 +105688,69 @@ "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the type of the nic", + "name": "type", "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -104596,48 +105758,53 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "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 NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -104646,77 +105813,124 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "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 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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the ID of the virtual machine", @@ -104724,187 +105938,356 @@ "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 type of the affinity group", - "name": "type", + "description": "the name of the security 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 description of the affinity group", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", "name": "description", "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "type": "set" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - {}, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the 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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" } ] }, @@ -104923,10 +106306,11 @@ } ], "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", @@ -104934,16 +106318,15 @@ "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" } ] }, @@ -104953,9 +106336,16 @@ "name": "listBaremetalDhcp", "params": [ { - "description": "Type of DHCP device", + "description": "", "length": 255, - "name": "dhcpservertype", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -104967,11 +106357,12 @@ "type": "long" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "", @@ -104981,17 +106372,9 @@ "type": "integer" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "Type of DHCP device", "length": 255, - "name": "keyword", + "name": "dhcpservertype", "required": false, "type": "string" } @@ -104999,40 +106382,40 @@ "related": "", "response": [ { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url", + "name": "url", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, + {}, { - "description": "device id of ", - "name": "id", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" } ] @@ -105054,19 +106437,29 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -105074,126 +106467,116 @@ "type": "integer" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", - "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", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - {}, - { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, - {}, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" } ] }, @@ -105204,48 +106587,48 @@ "params": [], "related": "", "response": [ - {}, { - "description": "DN password", - "name": "bindpass", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + }, + { + "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", - "type": "string" - }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "DN password", + "name": "bindpass", "type": "string" }, - {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", "name": "ssl", @@ -105260,24 +106643,24 @@ "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" }, { - "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" }, { @@ -105288,12 +106671,20 @@ "type": "string" }, { - "description": "email", + "description": "lastname", "length": 255, - "name": "email", + "name": "lastname", "required": true, "type": "string" }, + { + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "firstname", "length": 255, @@ -105302,69 +106693,86 @@ "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": "email", "length": 255, - "name": "account", + "name": "email", "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "Unique username.", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "getUser", + "response": [ + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the ID of the role", + "name": "roleid", "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 name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, - {}, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -105373,54 +106781,44 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the user state", "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", + "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 account ID of the user", + "name": "accountid", "type": "string" }, { @@ -105432,21 +106830,6 @@ "description": "the user email address", "name": "email", "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" } ] }, @@ -105466,24 +106849,13 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" - }, - {}, - { - "description": "the name of the api command", - "name": "name", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "description of the api", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -105501,13 +106873,8 @@ "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", + "description": "description of the api parameter", + "name": "description", "type": "string" }, { @@ -105516,47 +106883,54 @@ "type": "int" }, { - "description": "description of the api parameter", - "name": "description", + "description": "the name of the api parameter", + "name": "name", "type": "string" }, { - "description": "parameter type", - "name": "type", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "comma separated related apis to get the parameter", + "name": "related", "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "parameter type", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "response field type", - "name": "type", + "description": "the name of the api command", + "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + {}, { "description": "api response fields", "name": "response", "response": [ - { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "api response fields", - "name": "response", - "type": "set" - }, { "description": "description of the api response field", "name": "description", @@ -105566,14 +106940,23 @@ "description": "the name of the api response field", "name": "name", "type": "string" + }, + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" } ], "type": "set" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description of the api", + "name": "description", "type": "string" } ], @@ -105594,28 +106977,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -105623,14 +107006,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,23 +107013,48 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "public ip address id of the vpn gateway", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the project id", + "name": "projectid", + "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", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { @@ -105673,41 +107073,24 @@ "type": "date" }, { - "description": "the project id", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the vpc id of this gateway", - "name": "vpcid", + "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 public IP address", "name": "publicip", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { "description": "the domain id of the owner", "name": "domainid", "type": "string" - }, - { - "description": "the owner", - "name": "account", - "type": "string" } ] }, @@ -105716,13 +107099,6 @@ "isasync": true, "name": "createVMSnapshot", "params": [ - { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" - }, { "description": "snapshot memory if true", "length": 255, @@ -105730,14 +107106,6 @@ "required": false, "type": "boolean" }, - { - "description": "The ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - }, { "description": "The display name of the snapshot", "length": 255, @@ -105745,98 +107113,55 @@ "required": false, "type": "string" }, + { + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" + }, { "description": "The description of the snapshot", "length": 255, "name": "description", "required": false, "type": "string" + }, + { + "description": "The ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "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 ID of the vm snapshot", @@ -105844,33 +107169,38 @@ "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -105879,55 +107209,108 @@ "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, + {}, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name of the vpn", "name": "project", "type": "string" }, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, {}, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project 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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" } ], "since": "4.2.0" @@ -105945,13 +107328,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, @@ -105965,31 +107341,38 @@ "name": "resourceid", "required": true, "type": "string" + }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "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", - "type": "string" - } + {} ] }, { @@ -105998,18 +107381,20 @@ "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": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -106019,74 +107404,67 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the username of the vpn user.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "username", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The uuid of the Vpn user", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "addVpnUser,listVpnUsers", "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": "activateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "The uuid of the Vpn user", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username of the vpn user.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "addVpnUser", "response": [ + {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the state of the Vpn User", + "name": "state", "type": "string" }, { @@ -106095,34 +107473,39 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { - "description": "the state of the Vpn User", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -106147,22 +107530,22 @@ "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.2.0" @@ -106182,23 +107565,23 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -106211,13 +107594,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,10 +107607,27 @@ "name": "id", "required": true, "type": "integer" + }, + { + "description": "Region service endpoint", + "length": 255, + "name": "endpoint", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, + { + "description": "the name of the region", + "name": "name", + "type": "string" + }, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", @@ -106245,28 +107638,18 @@ "name": "portableipserviceenabled", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the region", - "name": "name", - "type": "string" - }, - {}, - {}, - { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the ID of the region", "name": "id", @@ -106286,13 +107669,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,9 +107676,26 @@ "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", @@ -106314,16 +107707,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -106333,20 +107716,11 @@ "name": "updateRolePermission", "params": [ { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "Role permission rule id", + "description": "ID of the role", "length": 255, - "name": "ruleid", + "name": "roleid", "related": "", - "required": false, - "since": "4.11", + "required": true, "type": "uuid" }, { @@ -106358,25 +107732,32 @@ "type": "string" }, { - "description": "ID of the role", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "roleid", + "name": "ruleorder", "related": "", - "required": true, + "required": false, + "type": "list" + }, + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", + "related": "", + "required": false, + "since": "4.11", "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -106385,10 +107766,12 @@ "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.9.0" }, @@ -106398,10 +107781,10 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "list objects by project", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -106413,41 +107796,34 @@ "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "A key pair name to look for", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the ssh keypair", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "listSSHKeyPairs", "required": false, "type": "uuid" }, - { - "description": "A key pair name to look for", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -106456,20 +107832,27 @@ "type": "integer" }, { - "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 ID of the ssh keypair", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "A public key fingerprint to look for", "length": 255, @@ -106480,51 +107863,51 @@ ], "related": "", "response": [ + { + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", - "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 keypair owner", "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" } ] @@ -106542,48 +107925,48 @@ "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "list account by account ID", "length": 255, - "name": "accounttype", + "name": "id", + "related": "enableAccount,listAccounts,listAccounts", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "flag to display the resource icon for accounts", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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 accounts by cleanuprequired attribute (values are true or false)", + "description": "", "length": 255, - "name": "iscleanuprequired", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list account by account ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -106593,87 +107976,157 @@ "type": "integer" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "details", + "name": "iscleanuprequired", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "list account by account name", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "name", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list account by account name", "length": 255, - "name": "pagesize", + "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", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "listall", + "name": "accounttype", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, { "description": "the total number of vpcs owned by account", "name": "vpctotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "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": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { @@ -106682,13 +108135,13 @@ "type": "string" }, { - "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) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -106702,77 +108155,72 @@ "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain name of the user", + "name": "domain", "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 user email address", + "name": "email", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -106781,24 +108229,24 @@ "type": "resourceiconresponse" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the type of the role", @@ -106806,8 +108254,8 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -106816,46 +108264,41 @@ "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the 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 name", + "name": "username", "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "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": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "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 that can be deployed by this account", - "name": "vmlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -106864,78 +108307,28 @@ "type": "integer" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "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", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "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", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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", - "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" }, { @@ -106944,14 +108337,14 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { "description": "the total number of snapshots which can be stored by this account", @@ -106959,18 +108352,13 @@ "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 list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { @@ -106979,71 +108367,66 @@ "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, - {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", @@ -107068,63 +108451,58 @@ "related": "", "response": [ { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "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 ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { @@ -107133,81 +108511,86 @@ "type": "date" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, + {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, - {}, { - "description": "the storage pool type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, - {}, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, { "description": "the storage pool capabilities", "name": "storagecapabilities", "type": "map" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "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 host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" } ] }, @@ -107228,227 +108611,105 @@ "related": "", "response": [ { - "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 list of nics associated with the router", - "name": "nic", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "result of the health check", + "name": "success", "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the Zone name for the router", - "name": "zonename", - "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" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 link local MAC address for the router", + "name": "linklocalmacaddress", + "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": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the template name for the router", + "name": "templatename", "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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -107457,13 +108718,13 @@ "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { @@ -107472,18 +108733,23 @@ "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { @@ -107492,74 +108758,63 @@ "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -107568,90 +108823,223 @@ "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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 date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { "description": "the public MAC address for the router", "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the 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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + } + ], + "type": "set" } ] }, @@ -107660,6 +109048,14 @@ "isasync": true, "name": "updateSnapshotPolicy", "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "an optional field, whether to the display the snapshot policy to the end user or not.", "length": 255, @@ -107675,35 +109071,53 @@ "related": "updateSnapshotPolicy", "required": false, "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "", "response": [ { - "description": "the 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": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -107712,13 +109126,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -107727,49 +109146,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "maximum number of snapshots retained", @@ -107777,23 +109170,18 @@ "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" } ] @@ -107815,8 +109203,8 @@ "related": "", "response": [ { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", "type": "integer" }, { @@ -107825,67 +109213,67 @@ "type": "date" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the result code for the job", + "name": "jobresultcode", "type": "integer" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the async command executed", - "name": "cmd", + "description": " the created date of the job", + "name": "created", + "type": "date" + }, + { + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, - {}, { "description": "the unique ID of the instance/entity object related to the job", "name": "jobinstanceid", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the account that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the user that executed the async command", + "name": "userid", + "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 instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the async command executed", + "name": "cmd", "type": "string" }, {}, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, - { - "description": "the account that executed the async command", - "name": "accountid", - "type": "string" - } + {} ] }, { @@ -107901,16 +109289,16 @@ "type": "integer" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "username", + "name": "ipaddress", "required": true, "type": "string" }, @@ -107924,46 +109312,29 @@ ], "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": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "name": "podids", "type": "list" }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, { "description": "true if NetScaler device is provisioned to be a GSLB service provider", "name": "gslbprovider", "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { @@ -107971,14 +109342,15 @@ "name": "provider", "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 exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -107986,10 +109358,16 @@ "name": "gslbproviderpublicip", "type": "string" }, + {}, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "device capacity", @@ -107997,9 +109375,14 @@ "type": "long" }, { - "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": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { "description": "the management IP address of the external load balancer", @@ -108007,8 +109390,13 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "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" } ] @@ -108019,26 +109407,35 @@ "name": "listImageStores", "params": [ { - "description": "the image store provider", + "description": "the name of the image store", "length": 255, - "name": "provider", + "name": "name", "required": false, "type": "string" }, { - "description": "the image store protocol", + "description": "read-only status of the image store", "length": 255, - "name": "protocol", + "name": "readonly", + "related": "listImageStores", "required": false, - "type": "string" + "since": "4.15.0", + "type": "boolean" }, { - "description": "the name of the image store", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the Zone ID for the image store", "length": 255, @@ -108055,35 +109452,26 @@ "type": "integer" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "read-only status of the image store", + "description": "the ID of the storage pool", "length": 255, - "name": "readonly", + "name": "id", "related": "listImageStores", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the image store protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the image store provider", "length": 255, - "name": "id", - "related": "listImageStores", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", @@ -108094,14 +109482,14 @@ "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the name of the image store", @@ -108109,13 +109497,18 @@ "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { @@ -108124,8 +109517,13 @@ "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { @@ -108133,33 +109531,23 @@ "name": "url", "type": "string" }, - {}, - {}, { "description": "the ID of the image store", "name": "id", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - } + {}, + {} ], "since": "4.2.0" }, @@ -108178,27 +109566,27 @@ } ], "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": "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" } ] }, @@ -108208,16 +109596,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" }, @@ -108236,26 +109624,21 @@ "name": "value", "type": "string" }, - { - "description": "Source of the counter.", - "name": "source", - "type": "string" - }, - {}, {}, { "description": "Name of the counter.", "name": "name", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Source of the counter.", + "name": "source", "type": "string" }, { @@ -108263,6 +109646,11 @@ "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", @@ -108277,22 +109665,22 @@ "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,72 +109701,72 @@ "related": "", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "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 operation result description", + "name": "description", + "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - } + {} ], "since": "4.9.0" }, @@ -108388,137 +109776,137 @@ "name": "addCluster", "params": [ { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "publicvswitchname", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "the URL", + "description": "the password for the host", "length": 255, - "name": "url", + "name": "password", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "the Zone ID for the cluster", "length": 255, - "name": "clustertype", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "guestvswitchname", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "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": "allocationstate", + "name": "publicvswitchtype", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "the cluster name", "length": 255, - "name": "guestvswitchtype", - "required": false, + "name": "clustername", + "required": true, "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the Pod ID for the host", "length": 255, - "name": "ovm3cluster", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "vsmipaddress", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "the cluster name", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "clustername", - "required": true, + "name": "ovm3pool", + "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "password", + "name": "publicvswitchname", "required": false, "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "ovm3vip", + "name": "guestvswitchtype", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "description": "the username for the cluster", "length": 255, - "name": "hypervisor", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vsmipaddress", + "required": false, + "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "ovm3pool", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "the username for the cluster", + "description": "the URL", "length": 255, - "name": "username", + "name": "url", "required": false, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "vsmusername", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clustertype", "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": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "publicvswitchtype", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "vsmpassword", + "name": "ovm3cluster", "required": false, "type": "string" } @@ -108526,68 +109914,48 @@ "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", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, { "description": "the Zone name", "name": "zonename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod ID", + "name": "podid", "type": "string" }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the capacity name", @@ -108595,13 +109963,18 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -108610,47 +109983,47 @@ "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" }, { "description": "the Pod name of the cluster", @@ -108658,26 +110031,41 @@ "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, + {}, { - "description": "the Zone name of the cluster", - "name": "zonename", + "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 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 Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, - {}, { "description": "the cluster ID", "name": "id", "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" } ] }, @@ -108690,13 +110078,12 @@ "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", @@ -108707,16 +110094,17 @@ "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" + }, {} ] }, @@ -108744,31 +110132,92 @@ ], "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "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": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "State of the Service from LB rule", @@ -108776,96 +110225,283 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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": "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, - { - "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 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 ID of the security group", "name": "id", @@ -108877,9 +110513,34 @@ "type": "integer" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -108890,19 +110551,19 @@ "name": "icmptype", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -108911,8 +110572,8 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -108925,13 +110586,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -108940,28 +110601,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -108970,604 +110631,316 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "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" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the 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": "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": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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 type of the nic", - "name": "type", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account owning the security group", + "name": "account", "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", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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 backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, { "description": "the name of the template for the virtual machine", "name": "templatename", "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "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 name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", @@ -109575,33 +110948,8 @@ "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 name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -109609,51 +110957,20 @@ "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", + "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 allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the name of the host for the virtual machine", @@ -109661,198 +110978,137 @@ "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "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": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Activates a project", - "isasync": true, - "name": "activateProject", - "params": [ - { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject", - "required": true, - "type": "uuid" - } - ], - "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", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "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 project", - "name": "state", - "type": "string" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, - {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, + {} + ] + }, + { + "description": "Activates a project", + "isasync": true, + "name": "activateProject", + "params": [ { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "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", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -109860,83 +111116,94 @@ "name": "vmlimit", "type": "string" }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, { "description": "the total volume being used by this project", "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, + {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -109949,63 +111216,184 @@ "name": "projectid", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "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" } ], "type": "list" }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, { "description": "the total number of snapshots stored by this project", "name": "snapshottotal", "type": "long" }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, { "description": "the total number of vpcs available to be created for this project", "name": "vpcavailable", "type": "string" }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, { "description": "the name of the project", "name": "name", "type": "string" }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + {}, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "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 public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" } ], "since": "3.0.0" @@ -110030,8 +111418,6 @@ "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -110042,11 +111428,13 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -110055,16 +111443,9 @@ "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" }, @@ -110077,47 +111458,48 @@ "type": "uuid" }, { - "description": "list dedicated hosts by affinity group", + "description": "the ID of the host", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the ID of the host", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "page", "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": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "page", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "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", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -110125,9 +111507,16 @@ "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the Account ID of the host", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -110136,19 +111525,18 @@ "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -110158,13 +111546,6 @@ "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, @@ -110172,6 +111553,13 @@ "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": "", @@ -110182,7 +111570,6 @@ "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -110192,7 +111579,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.14.0.0" }, @@ -110201,14 +111589,6 @@ "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, @@ -110216,14 +111596,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "the display text of the ISO. This is usually used for display purposes.", "length": 4096, @@ -110239,19 +111611,12 @@ "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", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, { "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, @@ -110268,14 +111633,29 @@ "type": "uuid" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "bootable", + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, "name": "zoneid", "related": "listZones", @@ -110283,74 +111663,82 @@ "type": "uuid" }, { - "description": "the name of the volume/template", + "description": "the name of the ISO", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "ispublic", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the name of the ISO", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, - { - "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": "the template/volume ID", "name": "id", - "type": "uuid" - }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" + "type": "uuid" }, { - "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": "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 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" }, @@ -110369,12 +111757,6 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -110386,11 +111768,17 @@ "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" - } + }, + {} ] }, { @@ -110399,34 +111787,34 @@ "name": "listPaloAltoFirewalls", "params": [ { - "description": "", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "page", + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Palo Alto firewall device ID", + "description": "the Physical Network ID", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -110439,29 +111827,29 @@ "related": "addPaloAltoFirewall", "response": [ { - "description": "device name", - "name": "fwdevicename", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device name", + "name": "fwdevicename", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" }, { "description": "name of the provider", @@ -110469,65 +111857,65 @@ "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the 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 number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, - {}, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "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": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" } ] @@ -110537,6 +111925,20 @@ "isasync": true, "name": "updateLoadBalancerRule", "params": [ + { + "description": "The protocol for the LB", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the ID of the load balancer rule to update", "length": 255, @@ -110546,17 +111948,11 @@ "type": "uuid" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "The protocol for the LB", + "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" }, { @@ -110575,17 +111971,9 @@ "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" } @@ -110593,34 +111981,29 @@ "related": "listLoadBalancerRules", "response": [ { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", + "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", + "description": "the project id of the load balancer", + "name": "projectid", "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 public port", - "name": "publicport", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the description of the load balancer", @@ -110628,20 +112011,15 @@ "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the domain ID of the load balancer rule", "name": "domainid", @@ -110649,18 +112027,19 @@ }, {}, { - "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 project name of the load balancer", - "name": "project", + "description": "the public ip address", + "name": "publicip", "type": "string" }, + {}, { - "description": "the private port", - "name": "privateport", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -110668,8 +112047,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -110678,28 +112062,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -110708,367 +112092,174 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Delete one or more alerts.", - "isasync": false, - "name": "deleteAlerts", - "params": [ - { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "delete by alert type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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": "Enables an account", - "isasync": false, - "name": "enableAccount", - "params": [ - { - "description": "Enables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "Enables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "listAccounts", - "response": [ - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "Delete one or more alerts.", + "isasync": false, + "name": "deleteAlerts", + "params": [ + { + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "delete by alert type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", + "params": [ + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "listAccounts", + "response": [ { - "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": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -111076,68 +112267,73 @@ "name": "user", "response": [ { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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 ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -111146,23 +112342,23 @@ "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 account name of the user", - "name": "account", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -111171,62 +112367,67 @@ "type": "date" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" } ], "type": "list" }, { - "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 templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "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", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { "description": "the date when this account was created", @@ -111234,43 +112435,230 @@ "type": "date" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { "description": "the total number of snapshots which can be stored by this account", "name": "snapshotlimit", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "the total number of networks available to be created for this account", "name": "networkavailable", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + {}, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, { "description": "the total number of cpu cores owned by account", "name": "cputotal", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "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": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + {}, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "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 number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" } ] @@ -111281,27 +112669,26 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "availability zone for the auto deployed virtual machine", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "destroyvmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "string" + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "counterparam", "required": false, - "type": "uuid" + "type": "map" }, { "description": "the service offering of the auto deployed virtual machine", @@ -111312,18 +112699,27 @@ "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", "length": 255, - "name": "counterparam", + "name": "otherdeployparams", "required": false, - "type": "map" + "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "destroyvmgraceperiod", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "getUser", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "an optional field, whether to the display the profile to the end user or not", @@ -111332,61 +112728,64 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "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" } ], "related": "", "response": [ { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the vm profile", + "name": "domainid", "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 availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "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 service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, + { + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" + }, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the ID of the user used to launch and destroy the VMs", "name": "autoscaleuserid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "the autoscale vm profile 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", @@ -111398,30 +112797,19 @@ "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" - }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project id vm profile", + "name": "projectid", "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" } ] }, @@ -111430,6 +112818,13 @@ "isasync": false, "name": "listLBStickinessPolicies", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -111438,11 +112833,12 @@ "type": "integer" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the load balancer stickiness policy", @@ -111453,12 +112849,11 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "the ID of the load balancer rule", @@ -111467,57 +112862,39 @@ "related": "", "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 LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, - {}, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { @@ -111525,28 +112902,33 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the state of the policy", - "name": "state", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the state of the policy", + "name": "state", "type": "string" }, { @@ -111555,9 +112937,9 @@ "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the LB Stickiness policy ID", @@ -111568,10 +112950,16 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" - } + }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + {} ], "since": "3.0.0" }, @@ -111581,10 +112969,10 @@ "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" }, { @@ -111595,13 +112983,6 @@ "required": true, "type": "uuid" }, - { - "description": "the name of UCS url", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": "the password of UCS", "length": 255, @@ -111615,19 +112996,20 @@ "name": "username", "required": true, "type": "string" + }, + { + "description": "the name of UCS manager", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { @@ -111636,19 +113018,25 @@ "type": "integer" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the name of ucs manager", - "name": "name", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, + {}, + {}, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" } ] @@ -111658,13 +113046,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,13 +113053,20 @@ "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": "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" }, { @@ -111686,12 +113074,12 @@ "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", @@ -111708,7 +113096,7 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } @@ -111716,64 +113104,60 @@ "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "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 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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "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": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the host", + "name": "name", + "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 ID of the host", @@ -111781,33 +113165,33 @@ "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "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 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 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 host type", - "name": "type", - "type": "type" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { @@ -111816,130 +113200,93 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "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 amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the IP address of the host", + "name": "ipaddress", "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 admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, - {}, { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { @@ -111956,9 +113303,9 @@ "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", @@ -111966,23 +113313,23 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "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", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -111991,8 +113338,8 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" } ], @@ -112001,10 +113348,46 @@ ], "type": "list" }, + {}, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "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": "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 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 cpu average load on the host", @@ -112012,69 +113395,74 @@ "type": "double" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" } ] }, @@ -112095,83 +113483,73 @@ "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 state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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", - "type": "boolean" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the 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", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "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 id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "keypair details", - "name": "keypair", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { @@ -112180,44 +113558,39 @@ "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the 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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, - {}, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { @@ -112226,49 +113599,64 @@ "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "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", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, - {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "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 state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, + {}, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" } ] @@ -112278,14 +113666,6 @@ "isasync": true, "name": "deleteProject", "params": [ - { - "description": "true if all project resources have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "id of the project to be deleted", "length": 255, @@ -112293,31 +113673,39 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "true if all project resources have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "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" - }, - {} + } ], "since": "3.0.0" }, @@ -112326,13 +113714,6 @@ "isasync": false, "name": "listNetscalerLoadBalancers", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the Physical Network ID", "length": 255, @@ -112342,12 +113723,11 @@ "type": "uuid" }, { - "description": "netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -112359,68 +113739,81 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "required": false, + "type": "uuid" } ], "related": "addNetscalerLoadBalancer", "response": [ { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "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": "device name", - "name": "lbdevicename", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, { "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": "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": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { "description": "name of the provider", @@ -112428,30 +113821,25 @@ "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, + {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -112475,13 +113863,6 @@ "required": false, "type": "string" }, - { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the domain ID of account owning the instance group", "length": 255, @@ -112489,66 +113870,73 @@ "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "the name of the instance group", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { "description": "the project ID of the instance group", "name": "projectid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, { "description": "the account owning the instance group", "name": "account", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the domain name of the instance group", + "name": "domain", "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the domain ID of the instance group", "name": "domainid", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -112569,15 +113957,14 @@ "related": "listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, {}, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -112585,14 +113972,15 @@ "name": "account", "type": "list" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112601,9 +113989,9 @@ "type": "list" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -112612,13 +114000,6 @@ "isasync": true, "name": "addNetscalerLoadBalancer", "params": [ - { - "description": "private IP of the site", - "length": 255, - "name": "gslbproviderprivateip", - "required": false, - "type": "string" - }, { "description": "public IP of the site", "length": 255, @@ -112627,16 +114008,9 @@ "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", - "length": 255, - "name": "isexclusivegslbprovider", - "required": false, - "type": "boolean" - }, - { - "description": "Credentials to reach netscaler load balancer device", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "password", + "name": "networkdevicetype", "required": true, "type": "string" }, @@ -112649,17 +114023,24 @@ "type": "uuid" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" + "name": "gslbprovider", + "required": false, + "type": "boolean" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", "length": 255, - "name": "username", - "required": true, + "name": "isexclusivegslbprovider", + "required": false, + "type": "boolean" + }, + { + "description": "private IP of the site", + "length": 255, + "name": "gslbproviderprivateip", + "required": false, "type": "string" }, { @@ -112670,29 +114051,50 @@ "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "gslbprovider", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - {}, { - "description": "device name", - "name": "lbdevicename", + "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" }, { @@ -112700,20 +114102,14 @@ "name": "lbdevicecapacity", "type": "long" }, - {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112726,14 +114122,15 @@ "name": "ipaddress", "type": "string" }, + {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -112742,28 +114139,19 @@ "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -112781,87 +114169,87 @@ "type": "string" }, { - "description": "the network id of the source ip address", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "scheme", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "fordisplay", - "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", - "length": 255, - "name": "sourceipaddress", + "description": "the description of the load balancer", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "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": "string" + "type": "integer" }, { - "description": "the source port the network traffic will be load balanced from", + "description": "The guest network the load balancer will be created for", "length": 255, - "name": "sourceport", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "The guest network the load balancer will be created for", + "description": "the network id of the source ip address", "length": 255, - "name": "networkid", + "name": "sourceipaddressnetworkid", "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the source port the network traffic will be load balanced from", "length": 255, - "name": "algorithm", + "name": "sourceport", "required": true, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { @@ -112870,69 +114258,54 @@ "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 rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the state of the instance", + "description": "the state of the load balancer rule", "name": "state", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the instance ID", - "name": "id", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" } ], "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -112940,6 +114313,11 @@ "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", @@ -112955,338 +114333,158 @@ "name": "key", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the 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, - "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", - "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, - "type": "string" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, - "type": "string" - }, - { - "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", - "type": "string" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, {}, { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "account id", - "name": "accountid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "domain name", - "name": "domain", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "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": "name of the VM", - "name": "virtualmachinename", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "account name", - "name": "account", - "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" + } + ], + "since": "4.2.0" + }, + { + "description": "Removes network permissions.", + "isasync": false, + "name": "removeNetworkPermissions", + "params": [ { - "description": "external backup id", - "name": "externalid", - "type": "string" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "zone id", - "name": "zoneid", - "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" }, { - "description": "zone name", - "name": "zone", - "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": "backed up volumes", - "name": "volumes", - "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" + } + ], + "response": [ + {}, + {}, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "backup date", - "name": "created", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.14.0" + "since": "4.17.0" }, { "description": "list baremetal pxe server", @@ -113294,11 +114492,11 @@ "name": "listBaremetalPxeServers", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Pxe server device ID", @@ -113307,17 +114505,10 @@ "required": false, "type": "long" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -113328,42 +114519,49 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "device id of ", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "url", "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of ", + "name": "id", "type": "string" }, + {}, { "description": "name of the provider", "name": "provider", "type": "string" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {} + } ] }, { @@ -113372,9 +114570,9 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "URL of the Palo Alto appliance.", + "description": "supports only PaloAltoFirewall", "length": 255, - "name": "url", + "name": "networkdevicetype", "required": true, "type": "string" }, @@ -113386,53 +114584,48 @@ "type": "string" }, { - "description": "supports only PaloAltoFirewall", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "networkdevicetype", + "name": "username", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "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": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { @@ -113441,65 +114634,70 @@ "type": "integer" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "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 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": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "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": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + {}, + { + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" } ] @@ -113509,13 +114707,6 @@ "isasync": true, "name": "createPrivateGateway", "params": [ - { - "description": "the gateway of the Private gateway", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" - }, { "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, @@ -113524,20 +114715,14 @@ "type": "boolean" }, { - "description": "the Physical Network ID the network belongs to", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, - { - "description": "the network implementation uri for the private gateway", - "length": 255, - "name": "vlan", - "required": true, - "type": "string" - }, { "description": "the IP address of the Private gateaway", "length": 255, @@ -113546,13 +114731,28 @@ "type": "string" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "networkofferingid", + "name": "physicalnetworkid", "related": "", "required": false, "type": "uuid" }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + }, + { + "description": "the network implementation uri for the private gateway", + "length": 255, + "name": "vlan", + "required": false, + "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, @@ -113561,9 +114761,9 @@ "type": "boolean" }, { - "description": "the netmask of the Private gateway", + "description": "the gateway of the Private gateway", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, @@ -113576,106 +114776,122 @@ "type": "uuid" }, { - "description": "the ID of the network ACL", + "description": "the netmask of the Private gateway", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "the uuid of the network offering to use for the private gateways network connection", + "length": 255, + "name": "networkofferingid", + "related": "", "required": false, "type": "uuid" } ], - "related": "", + "related": "createPrivateGateway", "response": [ - {}, { "description": "the private gateway's ip address", "name": "ipaddress", "type": "string" }, + {}, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "type": "string" + "description": "Souce Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the id of the private gateway", + "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 id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { @@ -113684,16 +114900,23 @@ "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, + {}, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" } - ] + ], + "since": "4.17.0" }, { "description": "Find user account by API key", @@ -113711,8 +114934,8 @@ "related": "", "response": [ { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -113721,13 +114944,13 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -113736,39 +114959,33 @@ "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 domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user name", + "name": "username", "type": "string" }, - {}, { "description": "the user firstname", "name": "firstname", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -113777,60 +114994,66 @@ "type": "resourceiconresponse" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + {}, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, + {}, { "description": "the domain ID of the user", "name": "domainid", "type": "string" }, - {}, - { - "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", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" } ] }, @@ -113840,50 +115063,49 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "the availability zone ID", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the load balancer rule", "length": 255, - "name": "keyword", + "name": "id", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "tags", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "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": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project", + "description": "the name of the load balancer rule", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network ID the rule belongs to", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -113901,72 +115123,68 @@ "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 public IP address ID of the load balancer rule", "length": 255, - "name": "listall", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "pagesize", + "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": "integer" + "type": "uuid" }, { - "description": "the name of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "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 ID of the load balancer rule", + "description": "the availability zone ID", "length": 255, - "name": "id", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, { "description": "the description of the load balancer", "name": "description", @@ -113974,18 +115192,18 @@ }, {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -113994,8 +115212,64 @@ "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 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 public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + {}, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -114003,132 +115277,81 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, { "description": "the state of the rule", "name": "state", "type": "string" }, - { - "description": "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", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -114148,20 +115371,14 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest 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" }, { @@ -114169,6 +115386,12 @@ "name": "success", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -114177,6 +115400,14 @@ "isasync": false, "name": "uploadSslCert", "params": [ + { + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "Private key", "length": 16384, @@ -114185,12 +115416,18 @@ "type": "string" }, { - "description": "domain ID of the account owning the SSL certificate", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, + "type": "string" + }, + { + "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", @@ -114207,13 +115444,6 @@ "since": "4.15", "type": "boolean" }, - { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "SSL certificate", "length": 16384, @@ -114222,9 +115452,9 @@ "type": "string" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -114235,26 +115465,20 @@ "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": "account for the certificate", + "name": "account", "type": "string" }, {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -114263,55 +115487,54 @@ "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "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", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "account for the certificate", - "name": "account", + "description": "certificate chain", + "name": "certchain", "type": "string" }, - {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" } ] }, @@ -114321,26 +115544,23 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "create site-to-site VPN customer gateway for the project", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "since": "4.6", - "type": "uuid" + "name": "cidrlist", + "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": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "esplifetime", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "ESP policy of the customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "esppolicy", + "name": "ipsecpsk", "required": true, "type": "string" }, @@ -114351,13 +115571,6 @@ "required": false, "type": "boolean" }, - { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, - "type": "string" - }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, @@ -114367,16 +115580,9 @@ "type": "boolean" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" - }, - { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "esppolicy", "required": true, "type": "string" }, @@ -114389,23 +115595,23 @@ "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "name of this customer gateway", "length": 255, - "name": "dpd", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "ikelifetime", + "required": false, + "type": "long" }, { - "description": "name of this customer gateway", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -114417,25 +115623,42 @@ "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, + "since": "4.6", + "type": "uuid" + }, + { + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "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": "ikelifetime", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" + }, + { + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -114444,43 +115667,28 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "name of the customer gateway", + "name": "name", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -114489,41 +115697,34 @@ "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" - }, - {}, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the project name", + "name": "project", "type": "string" }, - {}, { "description": "if Force NAT Encapsulation is enabled for customer gateway", "name": "forceencap", "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -114531,13 +115732,23 @@ "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -114545,11 +115756,23 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - } + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" + }, + {} ] }, { @@ -114558,18 +115781,17 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The netmask for the management network.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "netmask", "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,30 +115802,31 @@ "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": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "vlan", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "The gateway 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": "gateway", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "The netmask for the management network.", + "description": "The ending IP address.", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { - "description": "The starting IP address.", + "description": "The gateway for the management network.", "length": 255, - "name": "startip", + "name": "gateway", "required": true, "type": "string" } @@ -114611,8 +115834,45 @@ "related": "", "response": [ { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + } + ], "type": "list" }, { @@ -114621,68 +115881,49 @@ "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + {}, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", "type": "list" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, {}, { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, { "description": "the Zone name", "name": "zonename", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -114701,80 +115942,72 @@ "type": "short" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { "description": "the Cluster ID", "name": "clusterid", "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" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ + }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the capacity name", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on 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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "the ID of the Pod", "name": "id", "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" } ], "since": "4.11.0.0" @@ -114784,13 +116017,6 @@ "isasync": false, "name": "listCiscoNexusVSMs", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -114799,12 +116025,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,23 +116042,30 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "packet vlan id of the VSM", @@ -114841,23 +116073,24 @@ "type": "int" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "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": "device state", + "name": "vsmdevicestate", + "type": "string" }, + {}, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", "type": "int" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { @@ -114866,18 +116099,24 @@ "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", "type": "int" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, + {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { @@ -114889,12 +116128,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" } ] }, @@ -114904,9 +116137,9 @@ "name": "addVpnUser", "params": [ { - "description": "username for the vpn user", + "description": "password for the username", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -114919,169 +116152,61 @@ "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, - "name": "projectid", - "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", - "name": "username", - "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", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "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": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "id", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "username for the vpn user", + "length": 255, + "name": "username", "required": true, "type": "string" + }, + { + "description": "add vpn user to the specific project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the vpn userID", + "name": "id", + "type": "string" }, + {}, + {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the username of the vpn user", + "name": "username", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -115089,33 +116214,21 @@ "type": "integer" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the state of the Vpn User", + "name": "state", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "add a baremetal host", @@ -115123,18 +116236,12 @@ "name": "addBaremetalHost", "params": [ { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "hypervisor type of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the Pod ID for the host", @@ -115144,6 +116251,20 @@ "required": true, "type": "uuid" }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, { "description": "the cluster ID for the host", "length": 255, @@ -115160,45 +116281,37 @@ "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "hypervisor type of the host", "length": 255, - "name": "ipaddress", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the host URL", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "url", "required": true, - "type": "uuid" - }, - { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "password", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "username", "required": false, "type": "string" } @@ -115206,49 +116319,49 @@ "related": "", "response": [ { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "events available for the host", + "name": "events", "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" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "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 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 memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "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 outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { "description": "the date and time the host was last pinged", @@ -115256,103 +116369,103 @@ "type": "date" }, { - "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", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "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", + "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -115361,18 +116474,8 @@ "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { @@ -115389,13 +116492,13 @@ "name": "vgpu", "response": [ { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -115404,28 +116507,28 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "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": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" } ], @@ -115435,18 +116538,23 @@ "type": "list" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -115455,59 +116563,88 @@ "type": "date" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster 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", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the ID of the host", + "name": "id", "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": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, { "description": "the host hypervisor", "name": "hypervisor", "type": "hypervisortype" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "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 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 in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -115516,57 +116653,113 @@ "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 host type", + "name": "type", + "type": "type" }, + {}, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + {}, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { "description": "the amount of the host's CPU currently used", "name": "cpuused", "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 username of the user that entered the annotation", + "name": "username", + "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "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 ID of the host", - "name": "id", + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "the name of the entitiy to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "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 (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" }, - {}, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11" }, { "description": "Deletes a project role permission in the project", @@ -115574,17 +116767,17 @@ "name": "deleteProjectRolePermission", "params": [ { - "description": "ID of the project where the project role permission is to be deleted", + "description": "ID of the project role permission to be deleted", "length": 255, - "name": "projectid", + "name": "id", "related": "", "required": true, "type": "uuid" }, { - "description": "ID of the project role permission to be deleted", + "description": "ID of the project where the project role permission is to be deleted", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": true, "type": "uuid" @@ -115597,21 +116790,21 @@ "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.15.0" @@ -115632,27 +116825,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" - } + }, + {} ], "since": "4.9.0" }, @@ -115670,28 +116863,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", + "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": "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" + }, + {} ] }, { @@ -115699,6 +116892,20 @@ "isasync": true, "name": "updateVPCOffering", "params": [ + { + "description": "sort key of the VPC offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "the id of the VPC offering", "length": 255, @@ -115715,20 +116922,6 @@ "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", - "required": false, - "type": "string" - }, - { - "description": "the display text of the VPC offering", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, { "description": "the name of the VPC offering", "length": 255, @@ -115737,60 +116930,60 @@ "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the display text of the VPC offering", "length": 255, - "name": "state", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "sort key of the VPC 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": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the id of the vpc offering", + "name": "id", + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { @@ -115803,65 +116996,65 @@ "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", "name": "name", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "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", "type": "string" }, { - "description": "the provider name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the capability value", + "name": "value", "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" } ], "type": "list" @@ -115870,36 +117063,41 @@ "type": "list" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, + {}, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "description": "true if vpc 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", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -115917,29 +117115,24 @@ "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 vpn to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the vpn 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" } ], "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", @@ -115947,33 +117140,44 @@ "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { "description": "the public ip address of the vpn server", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -115982,24 +117186,18 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -116015,6 +117213,21 @@ "isasync": true, "name": "scaleVirtualMachine", "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 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": "the ID of the service offering for the virtual machine", "length": 255, @@ -116023,6 +117236,78 @@ "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": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "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" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", + "isasync": true, + "name": "destroyVirtualMachine", + "params": [ + { + "description": "Comma separated list of UUIDs for volumes that will be deleted", + "length": 255, + "name": "volumeids", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.12.0", + "type": "list" + }, { "description": "The ID of the virtual machine", "length": 255, @@ -116032,206 +117317,283 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value", + "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, - "name": "details", + "name": "expunge", "required": false, - "type": "map" + "since": "4.2.1", + "type": "boolean" } ], + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ + { + "description": "the 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": "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" - } - ] - }, - { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", - "params": [ + }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.2.1", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "Comma separated list of UUIDs for volumes that will be deleted", - "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.12.0", - "type": "list" - } - ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "ssh key-pairs", + "name": "keypairs", "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the 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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, - {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, { "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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 vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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 read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "the name of the virtual machine", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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": "the name of the disk offering of the virtual machine", @@ -116239,265 +117601,359 @@ "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", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "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 project ID of the affinity group", - "name": "projectid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "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": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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 id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -116506,23 +117962,28 @@ "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "account owning the security group rule", "name": "account", @@ -116533,26 +117994,6 @@ "name": "protocol", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -116564,74 +118005,32 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "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 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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { "description": "the domain ID of the security group", @@ -116639,13 +118038,28 @@ "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 project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -116653,39 +118067,24 @@ "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -116696,11 +118095,6 @@ "name": "resourcetype", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -116711,11 +118105,26 @@ "name": "domain", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -116730,13 +118139,23 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -116745,309 +118164,120 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the 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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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": "the ID of the nic", - "name": "id", - "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 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 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" + ], + "type": "set" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {} + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + } ] }, { @@ -117055,14 +118285,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,18 +118300,21 @@ "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", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -117097,64 +118322,43 @@ "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", - "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", - "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": "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 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": "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" }, { @@ -117163,13 +118367,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -117178,22 +118382,41 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { @@ -117201,19 +118424,31 @@ "name": "endport", "type": "integer" }, + {}, + { + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, + {}, { "description": "the ID of the firewall rule", "name": "id", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the state of the rule", + "name": "state", "type": "string" } ], @@ -117225,11 +118460,19 @@ "name": "listOsCategories", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list Os category by id", + "length": 255, + "name": "id", + "related": "listOsCategories", + "required": false, + "type": "uuid" }, { "description": "", @@ -117247,44 +118490,36 @@ "type": "string" }, { - "description": "list Os category by id", - "length": 255, - "name": "id", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the ID of the OS category", - "name": "id", + "description": "the name of the OS category", + "name": "name", "type": "string" }, { - "description": "the name of the OS category", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the ID of the OS category", + "name": "id", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -117294,34 +118529,13 @@ "name": "listServiceOfferings", "params": [ { - "description": "the CPU speed that listed offerings must support", - "length": 255, - "name": "cpuspeed", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the CPU number that listed offerings must support", - "length": 255, - "name": "cpunumber", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "description": "", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.13", + "type": "uuid" }, { "description": "List by keyword", @@ -117331,13 +118545,11 @@ "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "is this a system vm offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "issystem", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -117346,13 +118558,6 @@ "required": false, "type": "boolean" }, - { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, { "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", "length": 255, @@ -117361,6 +118566,21 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the RAM memory that listed offering must support", + "length": 255, + "name": "memory", + "required": false, + "since": "4.15", + "type": "integer" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -117370,12 +118590,19 @@ "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "ID of the service offering", "length": 255, @@ -117385,9 +118612,16 @@ "type": "uuid" }, { - "description": "the RAM memory that listed offering must support", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "memory", + "name": "systemvmtype", + "required": false, + "type": "string" + }, + { + "description": "the CPU number that listed offerings must support", + "length": 255, + "name": "cpunumber", "required": false, "since": "4.15", "type": "integer" @@ -117400,80 +118634,75 @@ "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 CPU speed that listed offerings must support", "length": 255, - "name": "listall", + "name": "cpuspeed", "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 date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "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 memory in MB", - "name": "memory", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, - {}, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "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", @@ -117481,80 +118710,101 @@ "type": "boolean" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "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 ha support in the service offering", - "name": "offerha", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, + {}, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the storage type for this service offering", + "name": "storagetype", + "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 min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "length (in second) of the burst", @@ -117562,69 +118812,74 @@ "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "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 memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "is this a the systemvm type for system vm offering", @@ -117632,24 +118887,24 @@ "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "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": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" } ] }, @@ -117659,45 +118914,45 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "the list load balancer rules that will be assigned to gloabal load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "The ID of the load balancer rule", + "description": "the list load balancer rules that will be assigned to gloabal load balancer rule", "length": 255, - "name": "id", + "name": "loadbalancerrulelist", "related": "", "required": true, - "type": "uuid" + "type": "list" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "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" - } + }, + {} ] }, { @@ -117705,13 +118960,6 @@ "isasync": false, "name": "listAffinityGroupTypes", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -117725,17 +118973,23 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, - {}, { "description": "the type of the affinity group", "name": "type", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -117745,56 +118999,9 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Assigns a VM to a backup offering", - "isasync": true, - "name": "assignVirtualMachineToBackupOffering", - "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", - "length": 255, - "name": "backupofferingid", - "related": "", - "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" }, {} - ], - "since": "4.14.0" + ] }, { "description": "Lists all the system wide capacities.", @@ -117809,19 +119016,27 @@ "type": "integer" }, { - "description": "", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "pagesize", + "name": "fetchlatest", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "boolean" }, { - "description": "lists capacity by the Zone ID", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "sortby", "required": false, - "type": "uuid" + "since": "3.0.0", + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "lists capacity by the Cluster ID", @@ -117833,77 +119048,69 @@ "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.", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "recalculate capacities and fetch the latest", + "description": "lists capacity by the Pod ID", "length": 255, - "name": "fetchlatest", + "name": "podid", + "related": "", "required": false, - "since": "3.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "Sort the results. Available values: Usage", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "sortby", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "3.0.0", - "type": "string" + "type": "uuid" }, { - "description": "lists capacity by the Pod ID", + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", "length": 255, - "name": "podid", - "related": "", + "name": "type", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the Pod name", "name": "podname", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, - {}, { "description": "the Cluster name", "name": "clustername", @@ -117914,35 +119121,35 @@ "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", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "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 Zone name", + "name": "zonename", "type": "string" }, + {}, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", "type": "string" } ] @@ -117953,28 +119160,21 @@ "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", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", + "name": "hostid", "related": "", "required": false, + "since": "3.0.1", "type": "uuid" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "podid", - "related": "", + "name": "deploymentplanner", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { "description": "The ID of the virtual machine", @@ -117985,226 +119185,262 @@ "type": "uuid" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "Boot into hardware setup menu or not", "length": 255, - "name": "hostid", + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + }, + { + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", "related": "", "required": false, - "since": "3.0.1", "type": "uuid" }, { - "description": "Boot into hardware setup menu or not", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "bootintosetup", + "name": "clusterid", + "related": "", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", "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", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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", - "type": "long" - }, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "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": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { "description": "the virtual network for the service offering", "name": "forvirtualnetwork", "type": "boolean" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -118213,38 +119449,33 @@ "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" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "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": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -118253,92 +119484,143 @@ "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the 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 type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "the 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 availability zone for the virtual machine", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, + {}, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { "description": "Guest vm Boot Type", @@ -118346,18 +119628,38 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -118366,34 +119668,135 @@ "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -118401,8 +119804,18 @@ "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -118410,28 +119823,28 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -118440,66 +119853,71 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -118511,18 +119929,23 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -118531,8 +119954,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -118541,85 +119964,45 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "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 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", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -118631,329 +120014,153 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "id of the resource", + "name": "resourceid", "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": "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 protocol of the security group rule", + "name": "protocol", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the 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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the security group", + "name": "id", "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 domain ID of the affinity group", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "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 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", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" } ] }, @@ -118963,12 +120170,12 @@ "name": "updateServiceOffering", "params": [ { - "description": "the ID of the service offering to be updated", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" }, { "description": "the display text of the service offering to be updated", @@ -118978,161 +120185,203 @@ "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the name of the service offering to be updated", "length": 255, - "name": "hosttags", + "name": "name", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the name of the service offering to be updated", - "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": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "sort key of the service offering, integer", "length": 255, - "name": "storagetags", + "name": "sortkey", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "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", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, - "name": "sortkey", + "name": "storagetags", "required": false, - "type": "integer" + "since": "4.16", + "type": "string" } ], "related": "", "response": [ { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, + {}, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "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 service offering in case of VMware", - "name": "vspherestoragepolicy", + "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": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, + {}, { - "description": "the memory in MB", - "name": "memory", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { @@ -119141,14 +120390,14 @@ "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "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", @@ -119156,49 +120405,38 @@ "type": "boolean" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "the number of CPU", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "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 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": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, - {}, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { @@ -119207,65 +120445,54 @@ "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, - {}, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, { "description": "the clock rate CPU speed in Mhz", "name": "cpuspeed", "type": "integer" }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, - { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, { "description": "the date this service offering was created", "name": "created", "type": "date" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" } ] }, @@ -119293,406 +120520,278 @@ "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the 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": "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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 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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "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 project id of the group", - "name": "projectid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "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", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" } ], "type": "set" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the virtual machine", + "name": "id", "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", + "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", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "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": "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -119701,98 +120800,104 @@ "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": "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 target memory in vm", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "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 name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -119801,33 +120906,28 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -119836,412 +120936,539 @@ "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 updated last time", + "name": "lastupdated", + "type": "date" }, { - "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 project name of the vm", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host", + "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", - "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", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "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", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the project name of the vm", + "name": "project", "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": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - { - "description": "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, {}, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "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", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the account owning the security group", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" } ] }, @@ -120250,6 +121477,13 @@ "isasync": true, "name": "createNetworkACLList", "params": [ + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -120259,10 +121493,10 @@ "type": "uuid" }, { - "description": "Name of the network ACL list", + "description": "Description of the network ACL list", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -120272,38 +121506,35 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "Description of the network ACL list", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", "response": [ {}, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "Description of the ACL", + "name": "description", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" + }, + { + "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": "the ID of the ACL", @@ -120311,17 +121542,18 @@ "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, + {}, { - "description": "Description of the ACL", - "name": "description", - "type": "string" + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] } ], - "count": 653 + "count": 650 } diff --git a/test/SSHService_test.go b/test/SSHService_test.go index e402656c..0c81e705 100644 --- a/test/SSHService_test.go +++ b/test/SSHService_test.go @@ -87,7 +87,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") _, err := client.SSH.ResetSSHKeyForVirtualMachine(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VPCService_test.go b/test/VPCService_test.go index 782c9dee..7394f427 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") _, err := client.VPC.CreatePrivateGateway(p) if err != nil { t.Errorf(err.Error()) From 8b6e3338055669933f080d75333f32052056bd22 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 16 Mar 2023 13:29:18 +0530 Subject: [PATCH 2/3] update 4.17 apis Signed-off-by: Abhishek Kumar --- cloudstack/KubernetesService.go | 8 + cloudstack/NicService.go | 2 + cloudstack/VirtualMachineService.go | 72 + generate/listApis.json | 114537 +++++++++++++------------ test/SSHService_test.go | 2 +- 5 files changed, 57572 insertions(+), 57049 deletions(-) diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index ba9a8703..07bcd3e2 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/NicService.go b/cloudstack/NicService.go index 58c50c30..63a63922 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 { diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 9d07aa12..0d16f97f 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -3503,6 +3503,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { 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) @@ -3525,6 +3528,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("haenable", vv) } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -3566,6 +3572,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["podid"]; found { + u.Set("podid", v.(string)) + } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } @@ -3582,6 +3591,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["state"]; found { u.Set("state", 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) { @@ -3664,6 +3676,21 @@ func (p *ListVirtualMachinesMetricsParams) GetBackupofferingid() (string, bool) 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{}) @@ -3754,6 +3781,21 @@ func (p *ListVirtualMachinesMetricsParams) GetHaenable() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetHypervisor(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3934,6 +3976,21 @@ func (p *ListVirtualMachinesMetricsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetPodid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["podid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetPodid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["podid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetProjectid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4009,6 +4066,21 @@ func (p *ListVirtualMachinesMetricsParams) GetState() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/generate/listApis.json b/generate/listApis.json index e3438b92..c50262ca 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -23,31 +23,31 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, + {}, { "description": "id of the resource", "name": "resourceid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" - }, - {}, { "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0.0" @@ -57,6 +57,15 @@ "isasync": true, "name": "createVPCOffering", "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": "the display text of the vpc offering", "length": 255, @@ -65,13 +74,11 @@ "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the name of the vpc offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { "description": "desired service capabilities as part of vpc offering", @@ -82,12 +89,12 @@ "type": "map" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "enable", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.16", - "type": "boolean" + "type": "list" }, { "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", @@ -97,6 +104,14 @@ "since": "4.17.0", "type": "string" }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, { "description": "the ID of the service offering for the VPC router appliance", "length": 255, @@ -105,13 +120,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "services supported by the vpc offering", "length": 255, @@ -125,59 +133,93 @@ "name": "serviceproviderlist", "required": false, "type": "map" - }, - { - "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" } ], "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", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -186,21 +228,26 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { "description": "the capability name", @@ -208,9 +255,9 @@ "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" @@ -219,23 +266,13 @@ "type": "list" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -243,52 +280,15 @@ "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": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { "description": "the name of the vpc offering", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" } ] }, @@ -298,27 +298,19 @@ "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 netmask for the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, - { - "description": "the Zone ID in which the Pod will be created", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "the name of the Pod", "length": 255, @@ -334,142 +326,98 @@ "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "startip", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "allocationstate", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the netmask for the Pod", + "length": 255, + "name": "netmask", + "required": true, "type": "string" } ], "related": "listPods,updatePod,createManagementNetworkIpRange", "response": [ - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, {}, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -478,33 +426,22 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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.", @@ -512,19 +449,82 @@ "type": "list" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "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 name of the Pod", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", "name": "forsystemvms", "type": "list" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the 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" } ] }, @@ -534,12 +534,18 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Creates the account under the specified role.", + "description": "Network domain for the account's networks", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" }, { "description": "Creates the user under the specified domain.", @@ -550,24 +556,25 @@ "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the account under the specified role.", "length": 255, - "name": "timezone", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "userid", + "name": "accountid", "required": false, "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "Unique username.", "length": 255, - "name": "networkdomain", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -578,10 +585,10 @@ "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" }, { @@ -597,25 +604,23 @@ "name": "accounttype", "required": false, "type": "integer" - }, - { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "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) owned by account", - "name": "memorytotal", + "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" }, { @@ -624,53 +629,50 @@ "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "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", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { @@ -679,19 +681,14 @@ "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the Domain the account belongs to", @@ -699,53 +696,53 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { @@ -754,48 +751,48 @@ "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -803,59 +800,59 @@ "name": "user", "response": [ { - "description": "the user name", - "name": "username", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "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 user lastname", @@ -863,33 +860,33 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the 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": "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 secret key of the user", - "name": "secretkey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -903,52 +900,47 @@ "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the domain name of the user", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { "description": "the total number of templates available to be created by this account", @@ -956,56 +948,59 @@ "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "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": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { "description": "the total primary storage space (in GiB) available to be used for this account", @@ -1013,18 +1008,23 @@ "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "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 number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" } ], @@ -1045,27 +1045,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": "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.6.0" }, @@ -1074,14 +1074,6 @@ "isasync": true, "name": "copyIso", "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.", - "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "Template ID.", "length": 255, @@ -1105,14 +1097,27 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" + }, + { + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "length": 255, + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "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", @@ -1120,76 +1125,24 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "the template name", @@ -1197,38 +1150,43 @@ "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -1237,71 +1195,81 @@ "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, - {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "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", @@ -1309,34 +1277,86 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 date this template was created", + "name": "created", + "type": "date" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "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": "true if template is sshkey enabled, false otherwise", @@ -1344,74 +1364,54 @@ "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "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 secondary storage host for the template", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "checksum of the template", + "name": "checksum", "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" } ] }, @@ -1435,22 +1435,22 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -1459,6 +1459,13 @@ "isasync": true, "name": "provisionCertificate", "params": [ + { + "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "length": 255, + "name": "reconnect", + "required": false, + "type": "boolean" + }, { "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, @@ -1467,13 +1474,6 @@ "required": true, "type": "uuid" }, - { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", - "length": 255, - "name": "reconnect", - "required": false, - "type": "boolean" - }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -1484,11 +1484,7 @@ ], "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", @@ -1499,12 +1495,16 @@ "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ], "since": "4.11.0" }, @@ -1513,6 +1513,13 @@ "isasync": false, "name": "addExternalFirewall", "params": [ + { + "description": "Password of the external firewall appliance.", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "Username of the external firewall appliance.", "length": 255, @@ -1521,9 +1528,9 @@ "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" }, @@ -1534,25 +1541,18 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "URL of the external firewall appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" } ], "related": "listExternalFirewalls", "response": [ { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { @@ -1562,18 +1562,13 @@ }, {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { @@ -1582,39 +1577,44 @@ "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the usage interface of the external firewall", "name": "usageinterface", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the ID of the network device", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" }, { - "description": "the ID of the network device", - "name": "id", + "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": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" } ] @@ -1625,11 +1625,12 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "account", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { "description": "list by the service offering", @@ -1641,20 +1642,11 @@ "type": "uuid" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list vms by affinity group", + "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": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list vms by ssh keypair name", @@ -1663,14 +1655,6 @@ "required": false, "type": "string" }, - { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, { "description": "list vms by template", "length": 255, @@ -1680,12 +1664,11 @@ "type": "uuid" }, { - "description": "the security group ID", + "description": "the group ID", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "groupid", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, - "since": "4.15", "type": "uuid" }, { @@ -1697,28 +1680,34 @@ "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "description": "the ID of the virtual machine", "length": 255, - "name": "showicon", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "the cluster ID", "length": 255, - "name": "backupofferingid", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "list vms by vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { "description": "", @@ -1728,57 +1717,58 @@ "type": "integer" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "list by the backup offering", "length": 255, - "name": "haenable", + "name": "backupofferingid", "required": false, - "since": "4.15", - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "the availability zone ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the storage ID where vm's volumes belong to", "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": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", "required": false, - "since": "4.4", - "type": "list" + "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": "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": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "details", + "name": "showicon", "required": false, - "type": "list" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "list by network id", "length": 255, - "name": "hypervisor", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the availability zone ID", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -1788,19 +1778,19 @@ "type": "boolean" }, { - "description": "list vms by iso", + "description": "list vms by vpc", "length": 255, - "name": "isoid", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "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": "list by network type; true if need to list vms using Virtual Network, false otherwise", @@ -1810,56 +1800,67 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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": "displayvm", + "name": "details", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the security group ID", "length": 255, - "name": "tags", + "name": "securitygroupid", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "map" + "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": "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 affinity group", "length": 255, - "name": "state", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the host ID", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "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": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "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 vms by iso", "length": 255, - "name": "isrecursive", + "name": "isoid", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -1868,215 +1869,123 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "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": "device ID of the root volume", - "name": "rootdeviceid", - "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", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" - }, + } + ], + "related": "listVirtualMachinesMetrics", + "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -2085,18 +1994,18 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the 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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -2105,29 +2014,24 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "the gateway of the nic", @@ -2135,66 +2039,31 @@ "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", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" } ], "type": "set" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { @@ -2203,38 +2072,73 @@ "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "disk write in MiB", + "name": "diskwrite", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -2242,166 +2146,384 @@ "name": "memory", "type": "integer" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + {}, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the domain ID of the security group", + "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "network read in MiB", + "name": "networkread", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -2410,18 +2532,18 @@ "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -2435,60 +2557,70 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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", + "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": "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -2496,6 +2628,11 @@ "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", @@ -2506,8 +2643,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -2521,8 +2663,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -2530,11 +2672,6 @@ "name": "value", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -2546,8 +2683,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -2561,26 +2698,6 @@ ], "type": "set" }, - { - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the ID of the security group", "name": "id", @@ -2590,191 +2707,147 @@ "description": "the name of the security group", "name": "name", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - {}, - { - "description": "disk read in MiB", - "name": "diskread", - "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 virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "network write in MiB", - "name": "networkwrite", - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 project name of the affinity group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain name of the security group", "name": "domain", "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "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": "disk write in MiB", - "name": "diskwrite", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -2783,88 +2856,56 @@ "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "network read in MiB", - "name": "networkread", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" } - ], - "since": "4.9.3" + ] }, { "description": "Lists hosts.", @@ -2872,66 +2913,69 @@ "name": "listHosts", "params": [ { - "description": "the state of the host", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "state", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the id of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", + "description": "the host type", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the Pod ID for the host", "length": 255, - "name": "resourcestate", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the id of the host", "length": 255, - "name": "keyword", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "details", + "name": "hypervisor", "required": false, - "type": "list" + "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the name of the host", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, @@ -2943,55 +2987,52 @@ "type": "boolean" }, { - "description": "the Pod ID for the host", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists hosts existing in particular cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "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 host type", + "description": "the state of the host", "length": 255, - "name": "type", + "name": "state", "required": false, "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "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": "outofbandmanagementenabled", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the host", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the Zone ID for 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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "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" } @@ -2999,319 +3040,320 @@ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "response": [ { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "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": "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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the 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": "the host type", - "name": "type", - "type": "type" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, { "description": "the amount of the host's memory currently allocated in bytes", "name": "memoryallocatedbytes", "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the host version", + "name": "version", "type": "string" }, - {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 admin that annotated this host", - "name": "username", + "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": "the host version", - "name": "version", + "description": "capabilities of the host", + "name": "capabilities", "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 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", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "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 IP address of the host", - "name": "ipaddress", + "description": "the Zone name of the host", + "name": "zonename", "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 cluster name of the host", - "name": "clustername", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + {}, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "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 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": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "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", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "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 amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "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'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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", @@ -3319,45 +3361,44 @@ "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, - {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" } ] }, @@ -3377,7 +3418,7 @@ "description": "Storage pool id", "length": 255, "name": "id", - "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", "required": true, "type": "uuid" } @@ -3396,13 +3437,13 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -3412,17 +3453,10 @@ "isasync": false, "name": "listVsphereStoragePolicyCompatiblePools", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -3434,6 +3468,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "ID of the storage policy", "length": 255, @@ -3443,45 +3484,54 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -3490,14 +3540,19 @@ "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -3505,13 +3560,13 @@ "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 storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { @@ -3519,80 +3574,66 @@ "name": "disksizetotal", "type": "long" }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool type", + "name": "type", + "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", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "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 overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, { "description": "Storage provider for this pool", "name": "provider", "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 Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" } ] }, @@ -3617,17 +3658,17 @@ "type": "string" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -3641,28 +3682,6 @@ "isasync": false, "name": "updateStoragePool", "params": [ - { - "description": "the Id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "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": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, @@ -3679,76 +3698,109 @@ "since": "4.15", "type": "string" }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" + }, + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, { "description": "bytes CloudStack can provision from this storage pool", "length": 255, "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 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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 tags for the storage pool", + "name": "tags", + "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 Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the Zone name of the storage pool", "name": "zonename", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the name of the storage pool", "name": "name", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { "description": "the hypervisor type of the storage pool", @@ -3756,80 +3808,69 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "Storage provider for this pool", - "name": "provider", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, { "description": "the total disk size of the storage pool", "name": "disksizetotal", "type": "long" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" } ], "since": "3.0.0" @@ -3839,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, @@ -3854,205 +3887,213 @@ "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 Pod name for the system VM", - "name": "podname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "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 systemvm agent version", - "name": "version", + "description": "the gateway for the system VM", + "name": "gateway", "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 Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "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 network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, - {}, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "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 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 template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "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", + "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 template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "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 job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the name of the system VM", + "name": "name", "type": "string" } ] @@ -4063,19 +4104,12 @@ "name": "importLdapUsers", "params": [ { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "account", + "name": "timezone", "required": false, "type": "string" }, - { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, { "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", "length": 255, @@ -4085,30 +4119,31 @@ "type": "uuid" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "", "length": 255, - "name": "group", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "Creates the account under the specified role.", "length": 255, - "name": "keyword", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "details for account used to store specific parameters", "length": 255, - "name": "pagesize", + "name": "accountdetails", "required": false, - "type": "integer" + "type": "map" }, { - "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 account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "timezone", + "name": "account", "required": false, "type": "string" }, @@ -4120,55 +4155,54 @@ "type": "integer" }, { - "description": "Creates the account under the specified role.", + "description": "List by keyword", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "length": 255, + "name": "group", + "required": false, + "type": "string" } ], "related": "searchLdap,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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's domain", + "name": "domain", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -4179,21 +4213,28 @@ "name": "username", "type": "string" }, + {}, { - "description": "The user's domain", - "name": "domain", + "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 Zone", + "description": "the zone ID of the network", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -4201,40 +4242,33 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list networks supporting certain services", "length": 255, - "name": "keyword", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of the domain associated with the zone", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "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" }, { @@ -4243,99 +4277,42 @@ "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "dedicateZone", - "response": [ + }, { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", - "type": "string" - }, - {}, - { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Lists all available networks.", - "isasync": false, - "name": "listNetworks", - "params": [ - { - "description": "list networks by restartRequired", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "restartrequired", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list networks supporting certain services", + "description": "list networks by ID", "length": 255, - "name": "supportedservices", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "list" + "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 resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the network belongs to VPC", "length": 255, - "name": "isrecursive", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "the ID or VID of the network", "length": 255, - "name": "acltype", + "name": "vlan", "required": false, + "since": "4.17.0", "type": "string" }, { @@ -4347,49 +4324,40 @@ "type": "uuid" }, { - "description": "type of the traffic", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "traffictype", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID or VID of the network", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vlan", + "name": "tags", "required": false, - "since": "4.17.0", - "type": "string" + "type": "map" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "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": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "networkfilter", "required": false, "since": "4.17.0", - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "type": "string" }, { - "description": "list networks by network offering ID", + "description": "true if network is system, false otherwise", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "issystem", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "specifyipranges", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -4401,47 +4369,40 @@ "type": "uuid" }, { - "description": "true if network is system, false otherwise", + "description": "type of the traffic", "length": 255, - "name": "issystem", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "keyword", + "name": "acltype", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "list networks by physical network id", "length": 255, - "name": "showicon", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list networks available for VM deployment", "length": 255, - "name": "listall", + "name": "canusefordeploy", "required": false, "type": "boolean" }, { - "description": "list networks by ID", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the network belongs to VPC", + "description": "List by keyword", "length": 255, - "name": "forvpc", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -4451,26 +4412,26 @@ "type": "integer" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "type", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list networks by network offering ID", "length": 255, - "name": "displaynetwork", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -4479,322 +4440,151 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "description": "list networks by physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", - "length": 255, - "name": "networkfilter", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the zone ID of the network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ + {}, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "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 type of the network", + "name": "type", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the 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": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, + {}, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "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" - } - ], - "type": "list" - }, - {}, { "description": "The routing mode of network offering", "name": "ip6routing", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { "description": "VPC the network belongs to", @@ -4802,66 +4592,90 @@ "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "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": "The external id of the network", + "name": "externalid", "type": "string" }, - {}, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, { "description": "the domain id of the network owner", "name": "domainid", @@ -4873,40 +4687,183 @@ "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "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", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "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": "the physical network id", "name": "physicalnetworkid", @@ -4918,38 +4875,110 @@ "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "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": "list dedicated zones by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the account associated with the zone. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "dedicateZone", + "response": [ + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4958,20 +4987,32 @@ "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - } + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, + {} ] }, { @@ -4990,51 +5031,51 @@ "related": "", "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the name of the storage pool", "name": "name", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", + "description": "default gateway of the pool", + "name": "gateway", "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 current available space of the pool", "name": "size", "type": "long" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "available iops of the pool", "name": "maxiops", "type": "long" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "controller of the pool", + "name": "controllerid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -5053,11 +5094,7 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, {}, { "description": "true if operation is executed successfully", @@ -5065,15 +5102,19 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.17" @@ -5084,21 +5125,12 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "The current ending IP address.", + "description": "The new starting IP address.", "length": 255, - "name": "currentendip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, + "name": "newstartip", + "required": false, "type": "string" }, - { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, { "description": "The new ending IP address.", "length": 255, @@ -5115,25 +5147,34 @@ "type": "string" }, { - "description": "The new starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "newstartip", - "required": false, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "The current ending IP address.", + "length": 255, + "name": "currentendip", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "string" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -5141,9 +5182,9 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0.0" @@ -5153,14 +5194,6 @@ "isasync": true, "name": "updateFirewallRule", "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, @@ -5173,81 +5206,83 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the ID of the firewall rule", + "name": "id", "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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project 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" }, { @@ -5256,69 +5291,75 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "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 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", + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, - {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.4" }, @@ -5329,11 +5370,10 @@ "params": [], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" }, {}, { @@ -5342,10 +5382,11 @@ "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" }, @@ -5355,19 +5396,26 @@ "name": "listSrxFirewalls", "params": [ { - "description": "SRX firewall device ID", + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "SRX firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", + "required": false, + "type": "uuid" }, { "description": "the Physical Network ID", @@ -5380,28 +5428,17 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "addSrxFirewall,configureSrxFirewall", "response": [ + {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { @@ -5410,65 +5447,59 @@ "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the private interface of the external firewall", + "name": "privateinterface", "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", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, {}, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "device name", - "name": "fwdevicename", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "device state", + "name": "fwdevicestate", + "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" }, { @@ -5477,14 +5508,24 @@ "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -5493,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, @@ -5507,31 +5541,38 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "name of the account to be removed from the project", + "length": 255, + "name": "account", + "required": true, + "type": "string" } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -5553,21 +5594,21 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Hypervisor name", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "Hypervisor name", - "name": "name", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -5601,21 +5642,15 @@ "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the OS category", - "name": "oscategoryid", + "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 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", @@ -5626,12 +5661,18 @@ "name": "isuserdefined", "type": "boolean" }, + { + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS type", + "name": "id", "type": "string" - } + }, + {} ], "since": "4.4.0" }, @@ -5641,60 +5682,60 @@ "name": "listGuestVlans", "params": [ { - "description": "List by keyword", + "description": "list guest vlan by vnet", "length": 255, - "name": "keyword", + "name": "vnet", "required": false, "type": "string" }, { - "description": "", + "description": "list guest vlan by id", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "", "length": 255, - "name": "allocatedonly", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list guest vlan by vnet", + "description": "List by keyword", "length": 255, - "name": "vnet", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list guest vlan by id", + "description": "list guest vlan by physical network", "length": 255, - "name": "id", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "list guest vlan by zone", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "allocatedonly", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list guest vlan by physical network", + "description": "list guest vlan by zone", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } @@ -5702,40 +5743,28 @@ "related": "", "response": [ { - "description": "the guest VLAN", - "name": "vlan", - "type": "string" - }, - { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" - }, - {}, - {}, - { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { @@ -5743,9 +5772,11 @@ "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { @@ -5753,20 +5784,25 @@ "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 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": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "type": "string" }, { "description": "the domain ID of the guest VLAN range", @@ -5774,19 +5810,24 @@ "type": "string" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", + "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" + "description": "the guest VLAN id", + "name": "id", + "type": "long" + }, + { + "description": "the zone name of the guest VLAN range", + "name": "zonename", + "type": "string" } ], "since": "4.17.0" @@ -5796,6 +5837,13 @@ "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, @@ -5811,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, @@ -5832,38 +5866,57 @@ "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": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, + { + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", "name": "max", "type": "long" }, { - "description": "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 project id of the resource limit", - "name": "projectid", + "description": "the domain ID of the resource limit", + "name": "domainid", "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 project id of the resource limit", + "name": "projectid", "type": "string" }, { @@ -5872,22 +5925,10 @@ "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 resource limit", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the resource limit", + "name": "project", "type": "string" - }, - {}, - {} + } ] }, { @@ -5911,6 +5952,12 @@ "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", @@ -5920,12 +5967,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -5935,89 +5976,84 @@ "name": "listHostsMetrics", "params": [ { - "description": "the id of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the host", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the host type", "length": 255, - "name": "resourcestate", + "name": "type", "required": false, "type": "string" }, { - "description": "", + "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": "page", + "name": "resourcestate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", - "length": 255, - "name": "details", + "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": "list" + "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "hahost", + "name": "outofbandmanagementenabled", "required": false, "type": "boolean" }, { - "description": "the Zone ID for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the id of the host", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host type", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "type", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "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": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the name of the host", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -6029,46 +6065,86 @@ "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "the state of the host", "length": 255, - "name": "outofbandmanagementenabled", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the state of the host", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "state", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the host's 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 entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -6077,38 +6153,48 @@ "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { @@ -6117,80 +6203,98 @@ "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, { "description": "the outgoing network traffic on the host", "name": "networkkbswrite", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, - {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { @@ -6199,117 +6303,108 @@ "type": "string" }, { - "description": "instances on the host", - "name": "instances", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "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 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": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "instances on the host", + "name": "instances", + "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, + {}, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { "description": "Maximum displays per user", @@ -6317,18 +6412,18 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -6337,60 +6432,71 @@ "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, + {}, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "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": "the admin that annotated this host", - "name": "username", + "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the total cpu used in Ghz", @@ -6398,49 +6504,49 @@ "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "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", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "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": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { "description": "true if the host is disconnected. False otherwise.", @@ -6448,83 +6554,18 @@ "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "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 average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", - "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" - } - ], - "since": "4.9.3" - }, - { - "description": "Release the dedication for the pod", - "isasync": true, - "name": "releaseDedicatedPod", - "params": [ + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + } + ], + "since": "4.9.3" + }, + { + "description": "Release the dedication for the pod", + "isasync": true, + "name": "releaseDedicatedPod", + "params": [ { "description": "the ID of the Pod", "length": 255, @@ -6536,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": "the UUID of the latest async job acting on 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" - } + {} ] }, { @@ -6565,71 +6606,70 @@ "name": "listAffinityGroups", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "lists affinity groups by name", "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": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "pagesize", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "", + "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 by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list the affinity group by the ID provided", + "description": "", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "lists affinity groups by type", @@ -6639,83 +6679,84 @@ "type": "string" }, { - "description": "lists affinity groups by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "listall", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createAffinityGroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, - {}, - {}, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the 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", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the affinity group", + "name": "description", + "type": "string" } ] }, @@ -6724,6 +6765,13 @@ "isasync": false, "name": "registerSSHKeyPair", "params": [ + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, @@ -6732,18 +6780,18 @@ "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -6753,21 +6801,14 @@ "name": "publickey", "required": true, "type": "string" - }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listSSHKeyPairs", "response": [ { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the owner of the keypair", @@ -6775,40 +6816,40 @@ "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "Name of the keypair", + "name": "name", "type": "string" }, {}, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Name of the keypair", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "ID of the ssh keypair", + "name": "id", "type": "string" } ] @@ -6829,27 +6870,27 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "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" - }, - {} + } ] }, { @@ -6858,10 +6899,18 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the pods to start maintenance on", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + }, + { + "description": "the IDs of the clusters to start maintenance on", + "length": 255, + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "list" }, @@ -6873,18 +6922,17 @@ "type": "string" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "podids", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "list" }, @@ -6896,13 +6944,6 @@ "required": false, "type": "list" }, - { - "description": "if rolling mechanism should continue in case of an error", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, @@ -6914,81 +6955,81 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the hosts skipped", - "name": "hostsskipped", + "description": "the hosts updated", + "name": "hostsupdated", "response": [ { - "description": "the ID of the skipped host", - "name": "hostid", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "output of the maintenance script on the host", + "name": "output", + "type": "string" + }, + { + "description": "the ID of the updated host", + "name": "hostid", + "type": "string" + }, + { + "description": "end date of the update on the host", + "name": "enddate", "type": "string" } ], "type": "list" }, {}, - {}, { "description": "indicates if the rolling maintenance operation was successful", "name": "success", "type": "boolean" }, { - "description": "in case of failure, details are displayed", - "name": "details", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hosts updated", - "name": "hostsupdated", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the hosts skipped", + "name": "hostsskipped", "response": [ { - "description": "the ID of the updated host", + "description": "the ID of the skipped host", "name": "hostid", "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", - "type": "string" - }, - { - "description": "start date of the update on the host", - "name": "startdate", - "type": "string" - }, - { - "description": "end date of the update on the host", - "name": "enddate", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "the reason to skip the host", + "name": "reason", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, + {} ] }, { @@ -7018,14 +7059,6 @@ "since": "4.4", "type": "string" }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -7033,30 +7066,38 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.4" @@ -7066,6 +7107,13 @@ "isasync": false, "name": "reserveIpAddress", "params": [ + { + "description": "the account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "the ID of the project to reserve with this IP address", "length": 255, @@ -7075,11 +7123,11 @@ "type": "uuid" }, { - "description": "the account to reserve with this IP address", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the ID of the domain to reserve with this IP address", @@ -7089,13 +7137,6 @@ "required": false, "type": "uuid" }, - { - "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 ID of the public IP address to reserve", "length": 255, @@ -7108,24 +7149,28 @@ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, - {}, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { @@ -7133,8 +7178,8 @@ "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" }, { @@ -7143,33 +7188,33 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -7178,36 +7223,26 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { @@ -7216,33 +7251,23 @@ "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 Network where ip belongs to", - "name": "networkname", - "type": "string" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", + "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { @@ -7250,29 +7275,35 @@ "name": "domainid", "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": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { @@ -7281,8 +7312,8 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { @@ -7291,49 +7322,59 @@ "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "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 domain the public IP address is associated with", - "name": "domain", + "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": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" } ], @@ -7344,14 +7385,6 @@ "isasync": true, "name": "restoreVirtualMachine", "params": [ - { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" - }, { "description": "Virtual Machine ID", "length": 255, @@ -7359,30 +7392,73 @@ "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the 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": "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", @@ -7394,8 +7470,113 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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" }, { @@ -7408,18 +7589,8 @@ "name": "affinitygroup", "response": [ { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -7428,18 +7599,18 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -7448,242 +7619,460 @@ "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the 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 project name of the vm", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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 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 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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project 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": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -7695,66 +8084,36 @@ "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -7763,23 +8122,23 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -7790,11 +8149,6 @@ ], "type": "set" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -7805,56 +8159,66 @@ "name": "cidr", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the 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", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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", + "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" }, { @@ -7863,13 +8227,13 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -7877,13 +8241,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -7892,13 +8256,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -7907,23 +8271,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], @@ -7944,11 +8308,6 @@ "name": "endport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -7956,40 +8315,44 @@ } ], "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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": "true if high-availability is enabled, false otherwise", @@ -7997,344 +8360,33 @@ "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Delete one or more events.", + "isasync": false, + "name": "deleteEvents", + "params": [ { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "delete by event type", + "length": 255, + "name": "type", + "required": false, "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 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": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "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 state of the virtual machine", - "name": "state", - "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" - }, - { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "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": "Type of adapter if available", - "name": "adaptertype", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the 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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Delete one or more events.", - "isasync": false, - "name": "deleteEvents", - "params": [ - { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "delete by event type", + "description": "the IDs of the events", "length": 255, - "name": "type", + "name": "ids", + "related": "listEvents", "required": false, - "type": "string" + "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\")", @@ -8344,22 +8396,14 @@ "type": "date" }, { - "description": "the IDs of the events", + "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "enddate", "required": false, - "type": "list" + "type": "date" } ], "response": [ - {}, - {}, - { - "description": "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", @@ -8370,6 +8414,13 @@ "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", @@ -8392,27 +8443,27 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "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" } ] }, @@ -8430,28 +8481,28 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "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" - } + {} ] }, { @@ -8459,17 +8510,25 @@ "isasync": false, "name": "listUcsBlades", "params": [ + { + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -8479,32 +8538,20 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" } ], "related": "associateUcsProfileToBlade", "response": [ + {}, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { @@ -8517,16 +8564,20 @@ "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "ucs blade dn", - "name": "bladedn", + "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" } ] }, @@ -8545,15 +8596,14 @@ ], "related": "getVolumeiScsiName", "response": [ - {}, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "type": "string" }, { @@ -8561,6 +8611,7 @@ "name": "jobstatus", "type": "integer" }, + {}, {} ] }, @@ -8569,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, @@ -8584,15 +8627,27 @@ "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": "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", @@ -8604,11 +8659,7 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -8626,27 +8677,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" } ] }, @@ -8656,19 +8707,13 @@ "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", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" - }, { "description": "the id of Os category to update the host with", "length": 255, @@ -8678,13 +8723,19 @@ "type": "uuid" }, { - "description": "Change the name of host", + "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", "length": 255, - "name": "name", + "name": "allocationstate", "required": false, - "since": "4.15", "type": "string" }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + }, { "description": "the ID of the host to update", "length": 255, @@ -8694,51 +8745,41 @@ "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 resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "description": "Change the name of host", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, + "since": "4.15", "type": "string" } ], "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 Pod name of the host", - "name": "podname", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { @@ -8747,183 +8788,107 @@ "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", - "type": "string" - }, - { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - {}, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum 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": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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": "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" }, { @@ -8932,23 +8897,33 @@ "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -8957,38 +8932,80 @@ "type": "map" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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 total disk size of the host", - "name": "disksizetotal", + "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", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + {}, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "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 Pod ID of the host", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -8997,24 +9014,49 @@ "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "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": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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 CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { "description": "the amount of the host's memory currently allocated", @@ -9022,25 +9064,24 @@ "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": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, - {}, { - "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { "description": "the outgoing network traffic on the host", @@ -9048,29 +9089,39 @@ "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the 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 amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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" } ] }, @@ -9079,21 +9130,6 @@ "isasync": true, "name": "createEgressFirewallRule", "params": [ - { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the network id of the port forwarding rule", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, { "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -9102,18 +9138,18 @@ "type": "list" }, { - "description": "type of firewallrule: system/user", + "description": "error code for this icmp message", "length": 255, - "name": "type", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "type of the icmp message being sent", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -9124,50 +9160,60 @@ "type": "boolean" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "the starting port of firewall rule", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "destcidrlist", + "required": false, + "type": "list" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "the starting port of firewall rule", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "startport", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", "required": false, "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "type of firewallrule: system/user", "length": 255, - "name": "destcidrlist", + "name": "type", "required": false, - "type": "list" + "type": "string" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", @@ -9175,122 +9221,127 @@ "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, + {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "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 state of the rule", + "name": "state", + "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "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": "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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 id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" } ] @@ -9301,39 +9352,41 @@ "name": "listVPCOfferings", "params": [ { - "description": "List by keyword", + "description": "list VPC offerings by state", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "true if need to list only default VPC offerings. Default value is false", "length": 255, - "name": "page", + "name": "isdefault", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list VPC offerings by display text", + "description": "", "length": 255, - "name": "displaytext", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list VPC offerings by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "isdefault", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.13", + "type": "uuid" }, { "description": "list VPC offerings by id", @@ -9343,6 +9396,13 @@ "required": false, "type": "uuid" }, + { + "description": "list VPC offerings by display text", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "list VPC offerings supporting certain services", "length": 255, @@ -9357,15 +9417,6 @@ "required": false, "type": "string" }, - { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, { "description": "", "length": 255, @@ -9381,64 +9432,54 @@ "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", - "type": "string" - }, - {}, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, { "description": "the name of the vpc offering", "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -9446,62 +9487,57 @@ "name": "id", "type": "string" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the id of the vpc offering", + "name": "id", + "type": "string" }, + {}, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -9515,19 +9551,34 @@ "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + { + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, { "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zone", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "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" } ] }, @@ -9546,6 +9597,7 @@ ], "related": "", "response": [ + {}, {}, { "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", @@ -9557,7 +9609,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -9570,13 +9621,6 @@ "isasync": true, "name": "uploadVolume", "params": [ - { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, { "description": "the ID of the zone the volume is to be hosted on", "length": 255, @@ -9586,16 +9630,24 @@ "type": "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.", + "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "checksum", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "type": "uuid" + }, + { + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "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" }, @@ -9608,19 +9660,18 @@ "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the 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": "Upload volume for the project", @@ -9631,80 +9682,90 @@ "type": "uuid" }, { - "description": "the name of the volume", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "Image store uuid", + "length": 255, + "name": "imagestoreuuid", + "required": false, "type": "string" } ], "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { @@ -9713,107 +9774,189 @@ "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "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", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -9822,47 +9965,42 @@ "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 project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { "description": "provisioning type used to create volumes.", @@ -9870,170 +10008,83 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, { "description": "ID of the service offering for root disk", "name": "serviceofferingid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - {}, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the disk volume", + "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 state of the disk volume", - "name": "state", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "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": "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" } ] @@ -10044,12 +10095,11 @@ "name": "listSecurityGroups", "params": [ { - "description": "lists security groups by virtual machine id", + "description": "List resources by tags (key/value pairs)", "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": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -10059,34 +10109,42 @@ "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list the security group by the id provided", "length": 255, - "name": "tags", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "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 security groups by name", "length": 255, - "name": "isrecursive", + "name": "securitygroupname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list the security group by the id provided", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -10095,16 +10153,17 @@ "type": "string" }, { - "description": "List by keyword", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -10117,122 +10176,66 @@ "type": "uuid" }, { - "description": "lists security groups by name", - "length": 255, - "name": "securitygroupname", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the id of the security group rule", + "name": "ruleid", "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" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -10241,33 +10244,33 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -10276,85 +10279,94 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "account owning the security group rule", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "set" }, + {}, { - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the 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", @@ -10375,13 +10387,38 @@ "name": "endport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -10400,8 +10437,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -10425,36 +10462,46 @@ "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 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": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the 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", @@ -10466,11 +10513,15 @@ "type": "integer" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, - {} + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } ] }, { @@ -10479,11 +10530,12 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface port", + "description": "the ID of the host", "length": 255, - "name": "port", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the host management interface user", @@ -10493,9 +10545,9 @@ "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the host management interface port", "length": 255, - "name": "driver", + "name": "port", "required": true, "type": "string" }, @@ -10507,31 +10559,36 @@ "type": "string" }, { - "description": "the host management interface IP address", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "address", + "name": "driver", "required": true, "type": "string" }, { - "description": "the ID of the host", + "description": "the host management interface IP address", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "address", "required": true, - "type": "uuid" + "type": "string" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -10539,26 +10596,15 @@ "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 out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -10567,8 +10613,8 @@ "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" }, { @@ -10576,19 +10622,24 @@ "name": "hostid", "type": "string" }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, { "description": "the out-of-band management interface username", "name": "username", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -10600,23 +10651,23 @@ "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": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -10629,11 +10680,16 @@ "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 current status of the latest async job acting on this object", @@ -10641,14 +10697,9 @@ "type": "integer" }, { - "description": "the name of the storage tag", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" } ] }, @@ -10667,11 +10718,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", @@ -10683,12 +10729,17 @@ "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" - } + }, + {} ] }, { @@ -10712,38 +10763,38 @@ "name": "projectids", "type": "list" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the template ID", "name": "id", "type": "string" }, + { + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, - {} + } ] }, { @@ -10763,130 +10814,125 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the gateway for the system VM", + "name": "gateway", "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 last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "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 template name for the system VM", - "name": "templatename", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { @@ -10895,33 +10941,28 @@ "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -10930,33 +10971,43 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" } ] @@ -10967,70 +11018,75 @@ "name": "listAnnotations", "params": [ { - "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": "List by keyword", "length": 255, - "name": "annotationfilter", + "name": "keyword", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "optional: the id of the user of the annotation", + "description": "", "length": 255, - "name": "userid", + "name": "page", "required": false, - "since": "4.16.0", - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the entity type", "length": 255, - "name": "keyword", + "name": "entitytype", "required": false, "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "description": "the id of the annotation", "length": 255, - "name": "entityid", + "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": "", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "pagesize", + "name": "userid", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "string" }, { - "description": "", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "page", + "name": "entityid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the id of the annotation", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { "description": "the contents of the annotation", @@ -11038,57 +11094,52 @@ "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 (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", + "type": "string" }, + {}, { "description": "True if the annotation is available for admins only", "name": "adminsonly", "type": "boolean" }, + {}, { "description": "the type of the annotated entity", "name": "entitytype", "type": "string" }, - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, { "description": "The username of the user that entered the annotation", "name": "username", "type": "string" }, - {}, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "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" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.11" }, @@ -11104,13 +11155,6 @@ "required": false, "type": "string" }, - { - "description": "the URL for swift", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": " key for the user for swift", "length": 255, @@ -11124,31 +11168,47 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "the URL for swift", + "length": 255, + "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 provider name of the image store", - "name": "providername", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the image store", "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the Zone ID of the image store", @@ -11161,44 +11221,35 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the url of the image store", + "name": "url", "type": "string" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, + {}, { - "description": "the url of the image store", - "name": "url", + "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 name of the image store", - "name": "name", + "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" @@ -11209,11 +11260,12 @@ "name": "archiveEvents", "params": [ { - "description": "archive by event type", + "description": "the IDs of the events", "length": 255, - "name": "type", + "name": "ids", + "related": "listEvents", "required": false, - "type": "string" + "type": "list" }, { "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -11223,43 +11275,42 @@ "type": "date" }, { - "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": "archive by event type", "length": 255, - "name": "enddate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { - "description": "the IDs of the events", + "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": "ids", - "related": "listEvents", + "name": "enddate", "required": false, - "type": "list" + "type": "date" } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -11278,9 +11329,10 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -11294,10 +11346,9 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], @@ -11309,98 +11360,98 @@ "name": "addSrxFirewall", "params": [ { - "description": "supports only JuniperSRXFirewall", + "description": "the Physical Network ID", "length": 255, - "name": "networkdevicetype", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to reach SRX firewall device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "URL of the SRX appliance.", + "description": "supports only JuniperSRXFirewall", "length": 255, - "name": "url", + "name": "networkdevicetype", "required": true, "type": "string" }, { "description": "Credentials to reach SRX firewall device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "URL of the SRX appliance.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "url", "required": true, - "type": "uuid" + "type": "string" } ], "related": "configureSrxFirewall", "response": [ { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, + {}, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, - {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -11409,35 +11460,35 @@ "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" } ] }, @@ -11447,76 +11498,72 @@ "name": "updateLoadBalancer", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to 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" }, { "description": "the ID of the load balancer", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "the state of the instance", + "description": "the state of the load balancer rule", "name": "state", "type": "string" } ], "type": "list" }, + { + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -11529,24 +11576,29 @@ "name": "domain", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -11558,81 +11610,85 @@ "type": "list" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "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 Load Balancer ID", - "name": "id", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the name of the Load Balancer", + "name": "name", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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": "the project name of the Load Balancer", - "name": "project", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { @@ -11641,21 +11697,16 @@ "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 project id of the Load Balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" - } + }, + {} ], "since": "4.4.0" }, @@ -11665,12 +11716,11 @@ "name": "scaleSystemVm", "params": [ { - "description": "The ID of the system vm", + "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { "description": "the service offering ID to apply to the system vm", @@ -11681,34 +11731,40 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", + "description": "The ID of the system vm", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { "description": "the host ID for the system VM", @@ -11716,69 +11772,59 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "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 private IP address for the system VM", - "name": "privateip", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "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": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "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", @@ -11786,33 +11832,28 @@ "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "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 private netmask for the system VM", - "name": "privatenetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the second DNS for the system VM", + "name": "dns2", "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 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" }, { @@ -11821,49 +11862,44 @@ "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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 template ID for the system VM", - "name": "templateid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "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" }, { @@ -11871,21 +11907,36 @@ "name": "zoneid", "type": "string" }, + { + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" + }, {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" } ] }, @@ -11894,13 +11945,6 @@ "isasync": false, "name": "listSnapshotPolicies", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of the disk volume", "length": 255, @@ -11910,12 +11954,12 @@ "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": "", @@ -11925,12 +11969,19 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" }, { "description": "", @@ -11943,113 +11994,113 @@ "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, { "description": "the time zone of the snapshot policy", "name": "timezone", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { "description": "is this policy for display to the regular user", "name": "fordisplay", "type": "boolean" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" } ] }, @@ -12059,46 +12110,54 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "name of this customer gateway", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "name", + "name": "esplifetime", "required": false, - "type": "string" + "type": "long" }, { - "description": "ESP policy of the customer gateway", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "esppolicy", + "name": "ikelifetime", + "required": false, + "type": "long" + }, + { + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", "required": true, "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "gateway", "required": true, "type": "string" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "id of customer gateway", "length": 255, - "name": "cidrlist", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" + "name": "ipsecpsk", + "required": true, + "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "name of this customer gateway", "length": 255, - "name": "ikelifetime", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { "description": "the account associated with the gateway. Must be used with the domainId parameter.", @@ -12108,133 +12167,99 @@ "type": "string" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "forceencap", + "name": "dpd", "required": false, "type": "boolean" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "splitconnections", + "name": "forceencap", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "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": "ikeversion", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.15.1", - "type": "string" + "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": "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": "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "ikeversion", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "string" }, { - "description": "id of customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "ikepolicy", "required": true, - "type": "uuid" - }, - { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "type": "string" } ], "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "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", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the project id", + "name": "projectid", "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": "the project id", - "name": "projectid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { @@ -12243,38 +12268,44 @@ "type": "string" }, { - "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", + "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "IPsec preshared-key of 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": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the owner", - "name": "account", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -12286,6 +12317,26 @@ "description": "name of the customer gateway", "name": "name", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } ] }, @@ -12294,13 +12345,6 @@ "isasync": false, "name": "lockAccount", "params": [ - { - "description": "Locks the specified account.", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "Locks the specified account on this domain.", "length": 255, @@ -12308,245 +12352,272 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, "type": "uuid" + }, + { + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, + "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,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 vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "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": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the network domain", + "name": "networkdomain", "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 networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, - {}, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "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 templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "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": "details for the account", - "name": "accountdetails", - "type": "map" + "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 snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "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", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, + {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { @@ -12554,18 +12625,18 @@ "name": "user", "response": [ { - "description": "the ID of the role", - "name": "roleid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -12574,38 +12645,28 @@ "type": "string" }, { - "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 account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "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 domain name of the user", - "name": "domain", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -12614,13 +12675,13 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -12629,24 +12690,29 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the type of the role", @@ -12654,82 +12720,67 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" } ], "type": "list" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { "description": "the ID of the role", "name": "roleid", "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" } ] }, @@ -12738,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, @@ -12745,168 +12803,71 @@ "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 network domain for the router", - "name": "networkdomain", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "detailed response generated on running health check", + "name": "details", "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the project id of the ipaddress", + "name": "projectid", "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": "the second DNS for the router", @@ -12914,129 +12875,124 @@ "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "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 ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, - {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -13045,38 +13001,185 @@ "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "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": "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 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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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" + } + ], + "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -13085,107 +13188,65 @@ "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, + {}, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the id of the router", + "name": "id", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -13194,14 +13255,6 @@ "isasync": false, "name": "listClusters", "params": [ - { - "description": "lists clusters by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "lists clusters by allocation state", "length": 255, @@ -13210,26 +13263,27 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists clusters by Pod ID", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "page", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "whether this cluster is managed by cloudstack", @@ -13239,19 +13293,19 @@ "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -13261,9 +13315,16 @@ "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "", "length": 255, - "name": "name", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "lists clusters by hypervisor type", + "length": 255, + "name": "hypervisor", "required": false, "type": "string" }, @@ -13275,138 +13336,73 @@ "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "lists clusters by the cluster name", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" } ], "related": "addCluster,updateCluster", "response": [ + {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the cluster name", + "name": "name", "type": "string" }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - {}, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "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 Cluster name", - "name": "clustername", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "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", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { @@ -13415,28 +13411,93 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", "type": "string" }, - {}, { "description": "the Zone ID of the cluster", "name": "zoneid", "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -13455,27 +13516,27 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -13486,26 +13547,19 @@ "name": "listProjectInvitations", "params": [ { - "description": "list invitations by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "list by project id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "keyword", + "name": "activeonly", "required": false, - "type": "string" + "type": "boolean" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -13530,13 +13584,27 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "isrecursive", + "required": false, + "type": "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, + "name": "state", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -13552,11 +13620,11 @@ "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" }, { "description": "list invitation by user ID", @@ -13565,40 +13633,40 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" - }, - { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", - "length": 255, - "name": "activeonly", - "required": false, - "type": "boolean" } ], "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 name of the project", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, + {}, { - "description": "the id of the invitation", - "name": "id", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { @@ -13607,32 +13675,25 @@ "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the name of the project", + "name": "project", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the invitation state", "name": "state", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the id of the invitation", + "name": "id", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -13642,25 +13703,27 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "List by keyword", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -13670,41 +13733,32 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the network ID for the egress firewall services", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, @@ -13715,6 +13769,14 @@ "required": false, "type": "integer" }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -13723,67 +13785,45 @@ "type": "boolean" }, { - "description": "the ID of IP address of the firewall services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - {}, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -13792,66 +13832,71 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "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", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the 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 state of the rule", - "name": "state", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { @@ -13859,25 +13904,41 @@ "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 starting port of firewall rule's port range", - "name": "startport", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" } ] @@ -13887,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, @@ -13907,19 +13961,26 @@ "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 name of the region", - "name": "name", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { "description": "the ID of the region", @@ -13927,15 +13988,16 @@ "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the name of the region", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -13946,8 +14008,7 @@ "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" - }, - {} + } ] }, { @@ -13966,27 +14027,27 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -13996,30 +14057,17 @@ "name": "listClustersMetrics", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "flag to display the capacity of the clusters", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "lists clusters by hypervisor type", + "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 allocation state", + "description": "lists clusters by the cluster name", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" }, @@ -14038,19 +14086,26 @@ "type": "integer" }, { - "description": "lists clusters by Pod ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "lists clusters by cluster type", @@ -14060,91 +14115,76 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "lists clusters by the cluster name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - {}, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "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 Pod ID of the cluster", - "name": "podid", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", + "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": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { "description": "the maximum memory deviation", @@ -14152,110 +14192,91 @@ "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, { "description": "running / total hosts in the cluster", "name": "hosts", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, { "description": "the total capacity available", "name": "capacitytotal", @@ -14266,67 +14287,107 @@ "name": "zonename", "type": "string" }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, { "description": "the capacity name", "name": "name", "type": "string" }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the capacity type", "name": "type", "type": "short" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod name", + "name": "podname", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the Cluster ID", "name": "clusterid", "type": "string" }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, { "description": "the Pod ID", "name": "podid", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ], "type": "list" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "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 cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" } ], @@ -14337,14 +14398,6 @@ "isasync": false, "name": "listProjectRolePermissions", "params": [ - { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, { "description": "ID of the project role", "length": 255, @@ -14352,23 +14405,42 @@ "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": false, "type": "uuid" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "related": "createProjectRolePermission", "response": [ + { + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" + }, + { + "description": "the description of the role permission", + "name": "description", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { @@ -14377,30 +14449,19 @@ "type": "integer" }, {}, - {}, - { - "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 ID of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } ], @@ -14420,11 +14481,18 @@ "type": "uuid" }, { - "description": "", + "description": "Hostname", "length": 255, - "name": "page", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "Port", @@ -14442,11 +14510,11 @@ "type": "boolean" }, { - "description": "Hostname", + "description": "", "length": 255, - "name": "hostname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -14454,44 +14522,37 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, + {}, + { + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "linked domain", + "name": "domainid", "type": "string" - }, - { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, - {} + } ], "since": "4.2.0" }, @@ -14500,6 +14561,13 @@ "isasync": false, "name": "listSecondaryStagingStores", "params": [ + { + "description": "the staging store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, { "description": "the name of the staging store", "length": 255, @@ -14508,16 +14576,16 @@ "type": "string" }, { - "description": "List by keyword", + "description": "the staging store provider", "length": 255, - "name": "keyword", + "name": "provider", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -14529,13 +14597,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the Zone ID for the staging store", "length": 255, @@ -14545,63 +14606,32 @@ "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" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - {}, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the Zone name of the image store", "name": "zonename", @@ -14612,27 +14642,58 @@ "name": "disksizeused", "type": "long" }, - {}, - { - "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 current status of the latest async job acting on this object", + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "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": "the url of the image store", - "name": "url", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" - } + }, + {}, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {} ], "since": "4.2.0" }, @@ -14642,19 +14703,19 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "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": "fordisplay", + "name": "iprange", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "an optional account for the VPN. Must be used with domainId.", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", @@ -14664,13 +14725,6 @@ "required": false, "type": "uuid" }, - { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", - "length": 255, - "name": "iprange", - "required": false, - "type": "string" - }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default", "length": 255, @@ -14685,10 +14739,27 @@ "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" } ], "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "response": [ + { + "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": "is vpn for display to the regular user", @@ -14696,18 +14767,13 @@ "type": "boolean" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { @@ -14716,23 +14782,18 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -14741,13 +14802,14 @@ "type": "integer" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, + {}, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { @@ -14755,10 +14817,9 @@ "name": "projectid", "type": "string" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" } ] @@ -14780,38 +14841,68 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "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 date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "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 guest IP address for the router", + "name": "guestipaddress", + "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" }, { @@ -14819,16 +14910,47 @@ "name": "serviceofferingid", "type": "string" }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, { "description": "true if the router template requires upgrader", "name": "requiresupgrade", "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "VPC the router belongs to", "name": "vpcid", @@ -14840,9 +14962,59 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "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 project name of the address", + "name": "project", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -14850,13 +15022,23 @@ "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -14868,6 +15050,16 @@ "name": "details", "type": "string" }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, { "description": "the type of the health check - basic or advanced", "name": "checktype", @@ -14877,72 +15069,62 @@ "description": "the name of the health check on the router", "name": "checkname", "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" } ], "type": "list" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -14951,18 +15133,18 @@ "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -14971,75 +15153,70 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", @@ -15047,8 +15224,8 @@ }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -15056,229 +15233,391 @@ "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, + {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the router", + "name": "name", "type": "string" + } + ] + }, + { + "description": "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'.", + "isasync": false, + "name": "changeServiceForVirtualMachine", + "params": [ + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "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 gateway for the router", - "name": "gateway", + "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 project name of the address", - "name": "project", + "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": "the host ID for the router", - "name": "hostid", + "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": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "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 public IP address for the router", - "name": "publicip", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of 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 domain associated with the router", - "name": "domain", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ] - }, - { - "description": "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'.", - "isasync": false, - "name": "changeServiceForVirtualMachine", - "params": [ + }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the 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": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { "description": "the total number of network traffic bytes received", @@ -15286,13 +15625,18 @@ "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 name of the template for the virtual machine", - "name": "templatename", + "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" }, { @@ -15301,8 +15645,40 @@ "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -15311,13 +15687,33 @@ "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -15325,23 +15721,28 @@ "name": "affinitygroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, { "description": "the name of the affinity group", "name": "name", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -15350,23 +15751,18 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project 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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -15378,18 +15774,13 @@ "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -15398,53 +15789,53 @@ "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 ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "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 ip address of the nic", @@ -15452,323 +15843,128 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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": "macaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "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", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - {}, - {}, - { - "description": "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 name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ], "type": "set" }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -15778,18 +15974,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -15798,23 +15989,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -15823,21 +16014,31 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "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", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -15845,82 +16046,47 @@ "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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" }, { @@ -15929,18 +16095,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -15949,36 +16115,76 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "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 ending IP of the security group rule ", - "name": "endport", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", @@ -15988,18 +16194,53 @@ "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 name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -16008,18 +16249,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -16028,202 +16264,47 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "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" } ], "type": "set" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" } ] @@ -16234,10 +16315,10 @@ "name": "resetConfiguration", "params": [ { - "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" }, @@ -16258,12 +16339,11 @@ "type": "uuid" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "the name of the configuration", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", @@ -16274,27 +16354,32 @@ "type": "uuid" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ - {}, { - "description": "the category of the configuration", - "name": "category", + "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" }, {}, @@ -16303,19 +16388,20 @@ "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": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, - { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -16324,18 +16410,13 @@ "type": "string" }, { - "description": "the name of the configuration", - "name": "name", - "type": "string" - }, - { - "description": "the description of the configuration", - "name": "description", - "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" } ], @@ -16346,20 +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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list mapping by its UUID", "length": 255, @@ -16369,11 +16436,11 @@ "type": "uuid" }, { - "description": "", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "page", + "name": "hypervisorversion", "required": false, - "type": "integer" + "type": "string" }, { "description": "list mapping by Guest OS Type UUID", @@ -16390,40 +16457,48 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" + "description": "the 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", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16436,17 +16511,23 @@ "name": "osnameforhypervisor", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" }, - {} + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + } ], "since": "4.4.0" }, @@ -16456,25 +16537,20 @@ "name": "listTemplates", "params": [ { - "description": "List by keyword", + "description": "list templates by zoneId", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" - }, - { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "If set to true, list only unique templates across zones", @@ -16485,41 +16561,48 @@ "type": "boolean" }, { - "description": "the template name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "show removed templates as well", "length": 255, - "name": "hypervisor", + "name": "showremoved", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "show removed templates as well", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "showremoved", + "name": "showicon", "required": false, "type": "boolean" }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -16528,125 +16611,133 @@ "type": "map" }, { - "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 resources by account. Must be used with the domainId parameter.", + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "account", - "required": false, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "the template name", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "listall", + "name": "ids", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "the template ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list templates by zoneId", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "details", + "name": "hypervisor", "required": false, - "since": "4.15", - "type": "list" + "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 datadisk templates by parent template id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "details", "required": false, - "since": "4.9", + "since": "4.15", "type": "list" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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 URL which the template/iso is registered from", - "name": "url", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "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", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { "description": "true if the template is managed across all Zones, false otherwise", @@ -16654,103 +16745,58 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "additional key/value details tied with template", + "name": "details", "type": "map" }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, { "description": "true if template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { @@ -16758,59 +16804,45 @@ "name": "bits", "type": "int" }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Lists the download progress of a template across all secondary storages", "name": "downloaddetails", "type": "list" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -16819,44 +16851,32 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - {}, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -16865,52 +16885,113 @@ "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 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 id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" } ] }, @@ -16919,14 +17000,6 @@ "isasync": true, "name": "createAutoScalePolicy", "params": [ - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" - }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -16941,6 +17014,14 @@ "required": false, "type": "integer" }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" + }, { "description": "the duration for which the conditions have to be true before action is taken", "length": 255, @@ -16951,14 +17032,20 @@ ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ + {}, { - "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 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" }, { @@ -16967,24 +17054,23 @@ "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", - "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", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, - {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { @@ -16992,27 +17078,22 @@ "name": "quiettime", "type": "integer" }, - {}, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on 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 IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - } + {} ] }, { @@ -17030,28 +17111,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -17061,99 +17142,51 @@ "params": [], "related": "", "response": [ + {}, { "description": "the last time a usage job successfully completed", "name": "lastsuccessfuljob", "type": "date" }, - { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the usage server", - "name": "state", - "type": "state" - }, - {}, - {}, { "description": "the time these statistics were collected", "name": "collectiontime", "type": "date" }, { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the state of the usage server", + "name": "state", + "type": "state" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" } ], - "since": "4.11" + "since": "4.17.0" }, { "description": "Lists physical networks", "isasync": false, "name": "listPhysicalNetworks", "params": [ - { - "description": "list physical network by id", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, { "description": "the Zone ID for the physical network", "length": 255, @@ -17163,11 +17196,12 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list physical network by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "search by name", @@ -17183,6 +17217,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -17194,18 +17235,18 @@ "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ { - "description": "name of the physical network", - "name": "name", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "name of the physical network", + "name": "name", "type": "string" }, { @@ -17219,13 +17260,8 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -17233,83 +17269,91 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "state of the physical network", + "name": "state", "type": "string" }, - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "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": "zone name of the physical network", - "name": "zonename", + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" + }, + { + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" } ], "since": "3.0.0" }, { - "description": "Lists all firewall rules for an IP address.", - "isasync": false, - "name": "listFirewallRules", + "description": "Enables HA for a zone", + "isasync": true, + "name": "enableHAForZone", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of IP address of the firewall services", + "description": "ID of the zone", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ], + "since": "4.11" + }, + { + "description": "Lists all firewall rules for an IP address.", + "isasync": false, + "name": "listFirewallRules", + "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, @@ -17321,34 +17365,33 @@ "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list firewall rules for certain network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list firewall rules for certain network", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "listall", "required": false, - "since": "4.3", - "type": "uuid" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -17359,23 +17402,118 @@ "required": false, "type": "integer" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, "name": "isrecursive", "required": false, "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 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 ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "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 public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -17393,58 +17531,42 @@ "name": "projectid", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - {}, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { @@ -17452,57 +17574,16 @@ "name": "ipaddress", "type": "string" }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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 state of the rule", "name": "state", "type": "string" }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "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": "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 current status of the latest async job acting on this object", "name": "jobstatus", @@ -17521,18 +17602,18 @@ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -17555,27 +17636,27 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -17584,14 +17665,6 @@ "isasync": true, "name": "extractIso", "params": [ - { - "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" - }, { "description": "the ID of the zone where the ISO is originally located", "length": 255, @@ -17613,33 +17686,53 @@ "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 account id to which the extracted object belongs", - "name": "accountid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {}, { "description": "", "name": "resultstring", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the id of extracted object", - "name": "id", + "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" }, { @@ -17647,6 +17740,11 @@ "name": "zonename", "type": "string" }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, { "description": "the status of the extraction", "name": "status", @@ -17663,14 +17761,14 @@ "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", @@ -17678,27 +17776,10 @@ "type": "string" }, { - "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": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the id of extracted object", + "name": "id", "type": "string" - }, - {}, - {} + } ] }, { @@ -17746,24 +17827,14 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the protocol of the image store", @@ -17771,23 +17842,29 @@ "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -17800,23 +17877,27 @@ "name": "id", "type": "string" }, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "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 provider name of the image store", + "name": "providername", + "type": "string" + }, { "description": "the name of the image store", "name": "name", "type": "string" - }, - {} + } ] }, { @@ -17824,21 +17905,6 @@ "isasync": true, "name": "createAffinityGroup", "params": [ - { - "description": "create affinity group for project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "optional description of the affinity group", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, @@ -17867,33 +17933,43 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "optional description of the affinity group", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -17903,20 +17979,10 @@ }, {}, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "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 current status of the latest async job acting on this object", "name": "jobstatus", @@ -17927,10 +17993,25 @@ "name": "description", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "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", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ] @@ -17950,28 +18031,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -17979,13 +18060,6 @@ "isasync": false, "name": "listInternalLoadBalancerElements", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -18009,28 +18083,30 @@ "type": "uuid" }, { - "description": "list internal load balancer elements by id", + "description": "", "length": 255, - "name": "id", - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list internal load balancer elements by id", + "length": 255, + "name": "id", + "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", + "required": false, + "type": "uuid" } ], - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", + "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement", "response": [ - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, { "description": "Enabled/Disabled the element", "name": "enabled", @@ -18038,11 +18114,6 @@ }, {}, {}, - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -18052,6 +18123,16 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" } ], "since": "4.2.0" @@ -18061,14 +18142,6 @@ "isasync": true, "name": "updateLBHealthCheckPolicy", "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "ID of load balancer health check policy", "length": 255, @@ -18084,30 +18157,39 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, {}, { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of healthcheckpolicies", @@ -18119,20 +18201,20 @@ "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, { "description": "the pingpath of the healthcheck policy", "name": "pingpath", "type": "string" }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy.", "name": "unhealthcheckthresshold", @@ -18143,27 +18225,27 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, { "description": "Number of consecutive health check success before declaring an instance healthy", "name": "healthcheckthresshold", "type": "int" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" } ], "type": "list" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { @@ -18171,60 +18253,27 @@ "name": "account", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" } ], "since": "4.4" }, { - "description": "Enables HA cluster-wide", + "description": "Reboots a virtual machine.", "isasync": true, - "name": "enableHAForCluster", + "name": "rebootVirtualMachine", "params": [ { - "description": "ID of the cluster", + "description": "Boot into hardware setup menu or not", "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 current status of the latest async job acting 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", + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", "type": "boolean" }, - {} - ], - "since": "4.11" - }, - { - "description": "Reboots a virtual machine.", - "isasync": true, - "name": "rebootVirtualMachine", - "params": [ { "description": "The ID of the virtual machine", "length": 255, @@ -18233,14 +18282,6 @@ "required": true, "type": "uuid" }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, { "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, @@ -18253,237 +18294,461 @@ "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project name of the group", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "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": "account owning the security group rule", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -18491,18 +18756,23 @@ "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": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -18511,8 +18781,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -18521,32 +18791,27 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -18554,127 +18819,80 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", + "description": "the description of the security 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 type of the affinity group", - "name": "type", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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 VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "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", @@ -18682,534 +18900,421 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "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", + "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": "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 disk offering of the virtual machine", - "name": "diskofferingname", - "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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 virtual machine", + "name": "id", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", "name": "instancename", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the 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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "name": "id", "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 domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project name of the affinity group", + "name": "project", "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": " 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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, + } + ] + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Creates a load balancer rule", "isasync": true, "name": "createLoadBalancerRule", "params": [ + { + "description": "the public port from where the network traffic will be load balanced from", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" + }, + { + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, { "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, @@ -19219,12 +19324,11 @@ "type": "uuid" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { "description": "the domain ID associated with the load balancer", @@ -19235,16 +19339,9 @@ "type": "uuid" }, { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the public port from where the network traffic will be load balanced from", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "publicport", + "name": "privateport", "required": true, "type": "integer" }, @@ -19256,54 +19353,48 @@ "type": "string" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "protocol", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" - }, - { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "name of the load balancer rule", "length": 255, - "name": "algorithm", + "name": "name", "required": true, "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.", + "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": "cidrlist", + "name": "openfirewall", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "account", - "required": false, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "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 account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "openfirewall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -19317,23 +19408,22 @@ "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "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 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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -19347,18 +19437,18 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -19367,51 +19457,51 @@ "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": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public port", - "name": "publicport", + "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 domain of the load balancer rule", - "name": "domain", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -19420,71 +19510,72 @@ "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, + {}, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "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" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the load balancer rule ID", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -19503,14 +19594,25 @@ ], "related": "listVsphereStoragePolicies", "response": [ + { + "description": "the ID of the Storage Policy", + "name": "id", + "type": "string" + }, + { + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" + }, + {}, { "description": "the description of the Storage Policy", "name": "description", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { @@ -19528,17 +19630,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "type": "string" - }, - { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" } ] }, @@ -19547,13 +19638,6 @@ "isasync": true, "name": "addGuestOsMapping", "params": [ - { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, { "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, @@ -19562,13 +19646,6 @@ "required": false, "type": "uuid" }, - { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, - "type": "string" - }, { "description": "OS name specific to the hypervisor", "length": 255, @@ -19582,25 +19659,24 @@ "name": "hypervisorversion", "required": true, "type": "string" - } - ], - "related": "updateGuestOsMapping", - "response": [ - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "length": 255, + "name": "osdisplayname", + "required": false, "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "updateGuestOsMapping", + "response": [ { "description": "standard display name for the Guest OS", "name": "osdisplayname", @@ -19612,27 +19688,42 @@ "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" - } + }, + { + "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" }, @@ -19652,51 +19743,36 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ - {}, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, {}, + {}, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -19705,19 +19781,34 @@ "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.9.0" @@ -19728,52 +19819,67 @@ "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 display text of the network offering", + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", "length": 255, - "name": "displaytext", + "name": "keepaliveenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "the id of the network offering", "length": 255, - "name": "maxconnections", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", "required": false, - "since": "4.13", "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": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", "length": 255, - "name": "keepaliveenabled", + "name": "availability", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the network offering", + "description": "update state for the network offering", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "sort key of the network offering, integer", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "sortkey", + "name": "maxconnections", "required": false, "type": "integer" }, @@ -19790,30 +19896,10 @@ "name": "tags", "required": false, "type": "string" - }, - { - "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", - "length": 255, - "name": "availability", - "required": false, - "type": "string" - }, - { - "description": "the id of the network offering", - "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" } ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "state of the network offering. Can be Disabled/Enabled/Inactive", "name": "state", @@ -19825,74 +19911,13 @@ "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the tags for the network offering", - "name": "tags", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -19900,42 +19925,11 @@ "name": "supportsstrechedl2subnet", "type": "boolean" }, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "availability of the network offering", - "name": "availability", - "type": "string" - }, - {}, - { - "description": "the id of the network offering", - "name": "id", - "type": "string" - }, { "description": "the date this network 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 list of supported services", "name": "service", @@ -19944,6 +19938,11 @@ "description": "the list of capabilities", "name": "capability", "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, { "description": "the capability value", "name": "value", @@ -19953,42 +19952,27 @@ "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "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": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -19997,24 +19981,39 @@ "type": "boolean" }, { - "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": "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", + "type": "string" } ], "type": "list" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "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" }, { @@ -20022,384 +20021,485 @@ "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 guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ + }, { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, - {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "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 Zone name for the system VM", - "name": "zonename", + "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 the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the network offering", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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 Pod name for the system VM", - "name": "podname", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" - }, + } + ] + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of the system VM", + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, "name": "id", - "type": "string" + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": false, + "type": "uuid" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "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": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "response": [ + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, + {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "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": "the Pod ID for the system VM", - "name": "podid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "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 system VM", - "name": "name", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" } ] }, { - "description": "Deletes an egress firewall rule", + "description": "Stops a system VM.", "isasync": true, - "name": "deleteEgressFirewallRule", + "name": "stopSystemVm", "params": [ { - "description": "the ID of the firewall rule", + "description": "The ID of the system virtual machine", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Updates a VPC", - "isasync": true, - "name": "updateVPC", - "params": [ - { - "description": "the display text of the VPC", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the id of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the VPC", - "length": 255, - "name": "name", - "required": false, + "description": "the systemvm agent version", + "name": "version", "type": "string" - } - ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "response": [ - {}, - { - "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", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "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 public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { @@ -20408,58 +20508,335 @@ "type": "integer" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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": "uuid of the network provider", - "name": "id", - "type": "string" - }, + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + {} + ] + }, + { + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", + "params": [ + { + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "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": "Updates a VPC", + "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, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the id of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "an optional field, whether to the display the vpc to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "the 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", + "type": "boolean" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", "type": "string" }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -20470,11 +20847,6 @@ "name": "servicelist", "type": "list" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "the provider name", "name": "name", @@ -20484,27 +20856,15 @@ "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": "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 value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -20513,18 +20873,13 @@ ], "type": "list" }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -20533,88 +20888,78 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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 name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, + {}, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, - {}, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" } ] }, @@ -20623,13 +20968,6 @@ "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, @@ -20637,107 +20975,127 @@ "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", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, + {}, + {}, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the 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 username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the 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 out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" } ], "since": "4.9.0" }, { - "description": "Lists all IPv6 firewall rules", + "description": "List resource detail(s)", "isasync": false, - "name": "listIpv6FirewallRules", + "name": "listResourceDetails", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "list by key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "key", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "if set to true, only details marked with display=true, are returned. False by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.3", + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list ipv6 firewall rules by network ID", + "description": "list by resource id", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "resourceid", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -20748,26 +21106,27 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "traffictype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists ipv6 firewall rule with the specified ID", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "name": "value", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -20776,13 +21135,6 @@ "required": false, "type": "boolean" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, @@ -20791,11 +21143,11 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -20803,713 +21155,452 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "listTags", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "customer associated with the tag", + "name": "customer", "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 starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, + {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "id of the resource", + "name": "resourceid", "type": "string" - }, + } + ], + "since": "4.2" + }, + { + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the ID of the port forwarding rule", + "description": "patches systemVM - CPVM/SSVM with the specified ID", + "length": 255, "name": "id", - "type": "string" - }, + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - {} - ] + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.17.0" }, { - "description": "List resource detail(s)", + "description": "Creates a network offering.", "isasync": false, - "name": "listResourceDetails", + "name": "createNetworkOffering", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "list by resource id", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "resourceid", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by key", + "description": "the name of the network offering", "length": 255, - "name": "key", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the display text of the network offering", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "displaytext", + "required": true, + "type": "string" }, { - "description": "", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "pagesize", + "name": "networkrate", "required": false, "type": "integer" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "fordisplay", + "name": "egressdefaultpolicy", "required": false, - "since": "4.3", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "listall", + "name": "enable", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "services supported by the network offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list by key, value. Needs to be passed only along with key", - "length": 255, - "name": "value", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "since": "4.4", "type": "string" }, { - "description": "list by resource type", + "description": "true if network offering supports vlans", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "specifyvlan", + "required": false, + "type": "boolean" }, { - "description": "List by keyword", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "keyword", + "name": "ispersistent", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "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": "page", + "name": "serviceproviderlist", "required": false, - "type": "integer" - } - ], - "related": "listTags", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "map" }, { - "description": "tag value", - "name": "value", + "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 project id the tag belongs to", - "name": "projectid", - "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": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the availability of network offering. Default value is Optional", + "length": 255, + "name": "availability", + "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "length": 255, + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the network offering is IP conserve mode enabled", + "length": 255, + "name": "conservemode", + "required": false, + "type": "boolean" }, - {}, - {}, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "since": "4.2" - }, - { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", - "isasync": true, - "name": "patchSystemVm", - "params": [ - { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "servicecapabilitylist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "forced", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "type": "uuid" } ], + "related": "listNetworkOfferings", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" - } - ], - "since": "4.17.0" - }, - { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", - "params": [ + }, { - "description": "the ID of the containing domain", - "length": 255, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "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" - } - ], - "related": "listDedicatedClusters", - "response": [ + }, { - "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", + "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "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 name of the cluster", - "name": "clustername", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, {}, - {}, { - "description": "the domain ID of the cluster", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", - "params": [ - { - "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 availability of network offering. Default value is Optional", - "length": 255, + "description": "availability of the network offering", "name": "availability", - "required": false, - "type": "string" - }, - { - "description": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, - "type": "string" - }, - { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "list" - }, - { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, "type": "string" }, - { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", - "length": 255, - "name": "keepaliveenabled", - "required": false, - "type": "boolean" - }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "length": 255, "name": "egressdefaultpolicy", - "required": false, - "type": "boolean" - }, - { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", - "length": 255, - "name": "ispersistent", - "required": false, - "type": "boolean" - }, - { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" - }, - { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" - }, - { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" - }, - { - "description": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, - "name": "forvpc", - "required": false, "type": "boolean" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", - "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" - }, - { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": true, - "type": "string" - }, - { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, + "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" - }, - { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, - { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" - }, - { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" - } - ], - "related": "listNetworkOfferings", - "response": [ - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "the id of the network offering", - "name": "id", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the id of the network offering", + "name": "id", "type": "string" }, - {}, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, { "description": "true if network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "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", + "description": "the capability name", + "name": "name", "type": "string" }, { @@ -21518,36 +21609,36 @@ "type": "boolean" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "state of the network provider", @@ -21555,14 +21646,19 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -21571,123 +21667,104 @@ "type": "list" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the network offering", - "name": "name", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, + {}, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ { - "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 Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + } + ], + "related": "listDedicatedClusters", + "response": [ { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "availability of the network offering", - "name": "availability", + "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 name of the cluster", + "name": "clustername", "type": "string" }, + {}, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { - "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", - "type": "boolean" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, - {}, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the domain ID of the cluster", + "name": "domainid", "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 end port for the rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, { "description": "the start port for the rule", "length": 255, @@ -21696,11 +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" + "type": "integer" }, { "description": "the public IP address ID of the forwarding rule, already associated via associateIp", @@ -21710,24 +21787,33 @@ "required": true, "type": "uuid" }, + { + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, { "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,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -21735,21 +21821,10 @@ "name": "privateendport", "type": "string" }, - {}, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the public ip address id for the port forwarding rule", @@ -21757,8 +21832,8 @@ "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" }, { @@ -21766,8 +21841,13 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -21776,18 +21856,18 @@ "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 domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -21796,62 +21876,46 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -21860,13 +21924,40 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "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", + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + {}, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" } ] @@ -21877,26 +21968,28 @@ "name": "listVolumesMetrics", "params": [ { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "integer" + "since": "4.9", + "type": "list" }, { - "description": "the cluster id the disk volume belongs to", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the disk volume", @@ -21907,25 +22000,17 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -21937,111 +22022,117 @@ "type": "string" }, { - "description": "the name of the disk volume", + "description": "the type of disk volume", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "list volumes on specified host", "length": 255, - "name": "state", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "displayvolume", "required": false, - "since": "4.9", - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "the type of disk volume", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "type", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.3", "type": "string" }, { - "description": "the ID of the availability zone", + "description": "list volumes by disk offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "List by keyword", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "the name of the disk volume", "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": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "listall", "required": false, - "since": "4.3", - "type": "string" + "type": "boolean" }, { - "description": "list volumes by disk offering", + "description": "the ID of the availability zone", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the pod id the disk volume belongs to", + "description": "the ID of the virtual machine", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "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 volumes on specified host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "displayvolume", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "listall", + "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.", + "length": 255, + "name": "isrecursive", "required": false, "type": "boolean" } @@ -22049,217 +22140,154 @@ "related": "", "response": [ { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "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", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "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": "size of the disk volume", "name": "size", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the status of the volume", + "name": "status", "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "pod name of the volume", - "name": "podname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "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": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "disk size in GiB", + "name": "sizegb", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "pod id of the volume", @@ -22267,113 +22295,134 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "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", + "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 project id of the vpn", - "name": "projectid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, { "description": "the bytes actually consumed on disk", "name": "virtualsize", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { @@ -22382,70 +22431,112 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, + {}, { "description": "ID of the disk volume", "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 disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "Hypervisor the volume belongs to", + "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": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "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" @@ -22466,14 +22557,9 @@ "related": "listElastistorVolume", "response": [ { - "description": "compression", - "name": "compression", - "type": "string" - }, - { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -22482,29 +22568,34 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", + "description": "syncronization", + "name": "sync", "type": "string" }, { - "description": "syncronization", - "name": "sync", + "description": "the UUID of the latest async job acting on 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": "the name of the volume", - "name": "name", + "description": "graceallowed", + "name": "graceallowed", + "type": "string" + }, + { + "description": "deduplication", + "name": "deduplication", "type": "string" } ] @@ -22531,6 +22622,13 @@ ], "related": "", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "Map of all possible details and their possible list of values", "name": "details", @@ -22540,14 +22638,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.13" }, @@ -22557,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,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } @@ -22592,18 +22683,8 @@ "related": "uploadSslCert", "response": [ { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the certificate", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "description": "name", + "name": "name", "type": "string" }, { @@ -22611,36 +22692,36 @@ "name": "loadbalancerrulelist", "type": "list" }, - {}, { - "description": "certificate", - "name": "certificate", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" }, + {}, + {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { @@ -22649,14 +22730,24 @@ "type": "string" }, { - "description": "name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "certificate chain", + "name": "certchain", + "type": "string" + }, + { + "description": "the project name of the certificate", + "name": "project", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -22666,9 +22757,16 @@ "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 state", + "length": 255, + "name": "state", "required": false, "type": "string" }, @@ -22681,31 +22779,31 @@ "type": "uuid" }, { - "description": "list gateways by vlan", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, { - "description": "list gateways by vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list gateways by ip address", "length": 255, - "name": "listall", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -22717,67 +22815,54 @@ "type": "boolean" }, { - "description": "list private gateway by id", + "description": "", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", + "name": "page", "required": false, - "type": "uuid" + "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": "", + "description": "list gateways by vpc", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "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 only resources belonging to the domain specified", + "description": "list private gateway by id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", "required": false, "type": "uuid" - }, - { - "description": "list gateways by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" } ], "related": "createPrivateGateway,createPrivateGateway", "response": [ { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" + "description": "Souce Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { "description": "VPC id the private gateway belongs to", @@ -22785,13 +22870,13 @@ "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { @@ -22800,89 +22885,95 @@ "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": "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": "the gateway", - "name": "gateway", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, {}, + {}, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" } ] @@ -22892,6 +22983,13 @@ "isasync": true, "name": "updateVmNicIp", "params": [ + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "the ID of the nic to which you want to assign private IP", "length": 255, @@ -22899,31 +22997,19 @@ "related": "listNics", "required": true, "type": "uuid" - }, - { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "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": "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the VM's disk write in KiB", @@ -22931,44 +23017,44 @@ "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "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 write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -22977,14 +23063,14 @@ "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": " an alternate display text of the 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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { "description": "the date when this virtual machine was updated last time", @@ -22992,100 +23078,197 @@ "type": "date" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - {}, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the 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 speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the 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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "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", "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 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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", @@ -23093,85 +23276,236 @@ "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { @@ -23179,232 +23513,227 @@ "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "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" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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": "id of the resource", - "name": "resourceid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "account owning the security group rule", + "name": "account", "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", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "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", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -23413,13 +23742,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -23428,8 +23757,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -23438,21 +23767,16 @@ "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "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" }, { @@ -23460,117 +23784,158 @@ "name": "securitygroupname", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the 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 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", + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the hypervisor on which the template runs", @@ -23578,415 +23943,151 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the 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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" - }, + } + ] + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": true, + "type": "uuid" }, { - "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 policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" - }, + } + ], + "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "response": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the description of the affinity group", + "description": "the description of the Stickiness policy", "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 ID of the affinity group", + "description": "the LB Stickiness policy ID", "name": "id", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "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 ID of the nic", - "name": "id", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - } - ] - }, - { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", - "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" - } - ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "response": [ { "description": "the state of the policy", "name": "state", "type": "string" }, - {}, - { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the 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 domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the domain of the Stickiness policy", + "name": "domain", "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" } ], @@ -23998,24 +24099,16 @@ "name": "listPods", "params": [ { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "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": "List by keyword", + "description": "list pods by allocation state", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, @@ -24035,23 +24128,31 @@ "type": "uuid" }, { - "description": "list pods by allocation state", + "description": "list Pods by Zone ID", "length": 255, - "name": "allocationstate", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "pagesize", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -24059,31 +24160,10 @@ "related": "updatePod,createManagementNetworkIpRange", "response": [ { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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", @@ -24094,8 +24174,8 @@ "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { @@ -24114,13 +24194,44 @@ "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" } ], "type": "list" }, + {}, + { + "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, { "description": "the capacity of the Pod", "name": "capacity", @@ -24130,40 +24241,30 @@ "name": "podid", "type": "string" }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, { "description": "the Cluster name", "name": "clustername", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { "description": "the Zone name", @@ -24171,9 +24272,9 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the Zone ID", @@ -24184,56 +24285,56 @@ "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 ID of the Pod", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the name of the Pod", + "name": "name", "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 name of the Pod", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - } + {} ] }, { @@ -24253,68 +24354,18 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -24323,130 +24374,58 @@ "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "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 name of the health check on the router", - "name": "checkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the gateway of the nic", @@ -24454,38 +24433,38 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "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": "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", - "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 NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -24494,127 +24473,127 @@ "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the 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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, { "description": "the date and time the router was created", "name": "created", "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, + {}, { - "description": "role of the domain router", - "name": "role", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "role of the domain router", + "name": "role", "type": "string" }, { @@ -24623,65 +24602,197 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "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 Zone name for the router", - "name": "zonename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "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": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { "description": "the template name for the router", "name": "templatename", "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" } ] }, @@ -24691,34 +24802,51 @@ "name": "updateDiskOffering", "params": [ { - "description": "burst requests read rate of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "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, + "type": "integer" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "updates name of the disk offering with this value", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "name", + "name": "iopswriteratemax", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "displayoffering", + "name": "bytesreadratemaxlength", "required": false, - "type": "boolean" + "since": "4.15", + "type": "long" }, { "description": "ID of the disk offering", @@ -24729,19 +24857,27 @@ "type": "uuid" }, { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", "required": false, + "since": "4.15", "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "byteswriteratemaxlength", + "name": "tags", "required": false, "since": "4.15", - "type": "long" + "type": "string" + }, + { + "description": "updates name of the disk offering with this value", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "length (in seconds) of the burst", @@ -24752,28 +24888,26 @@ "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", - "length": 255, - "name": "tags", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.15", "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "bytesreadrate", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cachemode", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { "description": "burst bytes read rate of the disk offering", @@ -24784,92 +24918,64 @@ "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "byteswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "iopsreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemax", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "sort key of the disk offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, "since": "4.13", "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" } ], "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { @@ -24877,45 +24983,25 @@ "name": "disksizestrictness", "type": "boolean" }, - { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "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": "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { "description": "length (in seconds) of the burst", @@ -24923,34 +25009,49 @@ "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + {}, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, - {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { @@ -24959,18 +25060,18 @@ "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { @@ -24979,59 +25080,69 @@ "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": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "unique ID of the disk offering", "name": "id", "type": "string" }, - {}, { "description": "the name of the disk offering", "name": "name", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, + {}, { - "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 ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { @@ -25057,9 +25168,9 @@ ], "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", @@ -25067,17 +25178,17 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -25095,12 +25206,17 @@ } ], "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", @@ -25111,11 +25227,6 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -25125,26 +25236,26 @@ "name": "addAccountToProject", "params": [ { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "roletype", + "name": "email", "required": false, "type": "string" }, { - "description": "email to which invitation to the project is going to be sent", + "description": "ID of the project to add the account to", "length": 255, - "name": "email", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "ID of the project role", + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "roletype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "name of the account to be added to the project", @@ -25154,24 +25265,19 @@ "type": "string" }, { - "description": "ID of the project to add the account to", + "description": "ID of the project role", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -25179,12 +25285,17 @@ "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.0" }, @@ -25194,32 +25305,34 @@ "name": "listSnapshots", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "snapshottype", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list snapshots by zone id", @@ -25230,20 +25343,18 @@ "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "List by keyword", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists snapshot by snapshot ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "lists snapshot by snapshot name", @@ -25253,123 +25364,98 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "snapshottype", "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": "lists snapshot by snapshot ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "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": "the IDs of the snapshots, mutually exclusive with id", + "description": "", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "pagesize", "required": false, - "since": "4.9", - "type": "list" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "account", + "name": "intervaltype", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "listall", + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "the ID of the disk volume", "length": 255, - "name": "intervaltype", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - {}, { "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, { "description": "display name of the os on volume", "name": "osdisplayname", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "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": "true if the entity/resource has annotations", @@ -25377,33 +25463,28 @@ "type": "boolean" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -25411,18 +25492,8 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -25431,8 +25502,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -25441,13 +25512,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -25456,19 +25527,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { "description": "the domain ID of the snapshot's account", "name": "domainid", @@ -25479,40 +25564,66 @@ "name": "locationtype", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { "description": "name of the snapshot", "name": "name", "type": "string" - } - ] - }, - { - "description": "Reset site to site vpn connection", - "isasync": true, - "name": "resetVpnConnection", - "params": [ + }, { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", + "params": [ + { + "description": "an optional account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", "required": true, "type": "uuid" }, @@ -25528,13 +25639,18 @@ "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "the domain name of the owner", - "name": "domain", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { @@ -25542,6 +25658,16 @@ "name": "project", "type": "string" }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, { "description": "the domain id of the owner", "name": "domainid", @@ -25553,31 +25679,42 @@ "type": "date" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, { "description": "if Force NAT Encapsulation is enabled for customer gateway", "name": "forceencap", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the project id", + "name": "projectid", "type": "string" }, + {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the connection ID", + "name": "id", + "type": "string" }, - {}, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", "name": "ikeversion", @@ -25589,80 +25726,54 @@ "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "is connection 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": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the connection ID", - "name": "id", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Lifetime of 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 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": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the project id", - "name": "projectid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" - }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" } ] }, @@ -25672,11 +25783,12 @@ "name": "listKubernetesClusters", "params": [ { - "description": "state of the Kubernetes cluster", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "state", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -25686,39 +25798,37 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "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 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": "the ID of the Kubernetes cluster", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -25731,69 +25841,65 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", "length": 255, - "name": "isrecursive", + "name": "name", "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": "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": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "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 memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "keypair details", + "name": "keypair", "type": "string" }, - {}, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { "description": "Public IP Address ID of the cluster", @@ -25801,44 +25907,49 @@ "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "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 cluster", - "name": "id", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the domain in which the Kubernetes cluster exists", @@ -25846,90 +25957,95 @@ "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "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 control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, + {}, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, { "description": "the cpu cores of the Kubernetes cluster", "name": "cpunumber", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" } ] }, @@ -25953,13 +26069,6 @@ "required": false, "type": "uuid" }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the project associated with keypair", "length": 255, @@ -25967,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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -26000,42 +26116,42 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "the frequency at which the conditions have to be evaluated", "length": 255, - "name": "fordisplay", + "name": "interval", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "list of scaledown autoscale policies", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "maxmembers", "required": true, - "type": "list" + "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "uuid" + "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.", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "minmembers", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "integer" + "type": "list" }, { - "description": "the frequency at which the conditions have to be evaluated", + "description": "the ID of the load balancer rule", "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { "description": "the autoscale profile that contains information about the vms in the vm group.", @@ -26046,58 +26162,43 @@ "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" }, { - "description": "list of scaleup autoscale policies", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ - { - "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" - }, { "description": "is group for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, { "description": "the 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": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" + }, { "description": "the current state of the AutoScale Vm Group", "name": "state", @@ -26108,15 +26209,17 @@ "name": "id", "type": "string" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "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.", @@ -26124,32 +26227,45 @@ "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": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {} + { + "description": "the 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 frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + } ] }, { @@ -26160,39 +26276,49 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "query to search using", + "description": "List by keyword", "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "query to search using", "length": 255, - "name": "keyword", - "required": false, + "name": "query", + "related": "searchLdap,listLdapUsers", + "required": true, "type": "string" } ], "related": "listLdapUsers", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's email", + "name": "email", + "type": "string" + }, {}, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -26201,8 +26327,19 @@ "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, + {}, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "description": "The user's username", + "name": "username", "type": "string" }, { @@ -26210,34 +26347,52 @@ "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" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "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 user's principle", - "name": "principal", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "The user's username", - "name": "username", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.2.0" + ] }, { "description": "add a baremetal ping pxe server", @@ -26252,31 +26407,38 @@ "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Root directory on PING storage server", "length": 255, - "name": "username", + "name": "pingdir", "required": true, "type": "string" }, + { + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, { "description": "Credentials to reach external pxe device", "length": 255, - "name": "password", + "name": "username", "required": true, "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": "type of pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "pxeservertype", + "name": "url", "required": true, "type": "string" }, @@ -26287,13 +26449,6 @@ "required": true, "type": "string" }, - { - "description": "Username of PING storage server", - "length": 255, - "name": "pingcifsusername", - "required": false, - "type": "string" - }, { "description": "Password of PING storage server", "length": 255, @@ -26302,49 +26457,38 @@ "type": "string" }, { - "description": "Pod Id", + "description": "Username of PING storage server", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pingcifsusername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "URL of the external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Root directory on PING storage server", + "description": "type of pxe device", "length": 255, - "name": "pingdir", + "name": "pxeservertype", "required": true, "type": "string" } ], "related": "", "response": [ - { - "description": "url", - "name": "url", - "type": "string" - }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { @@ -26352,65 +26496,37 @@ "name": "provider", "type": "string" }, - {}, { - "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" }, + {}, { - "description": "device id of ", - "name": "id", + "description": "url", + "name": "url", "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": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "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", + "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" } ] }, @@ -26420,103 +26536,72 @@ "name": "listPortableIpRanges", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "Id of the portable ip range", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Id of the portable ip range", + "description": "Id of a Region", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "regionid", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Id of a Region", + "description": "", "length": 255, - "name": "regionid", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "createPortableIpRange", "response": [ - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, - { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - {}, - { - "description": "portable IP range ID", - "name": "id", - "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", - "type": "string" - }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { "description": "VPC the ip belongs to", @@ -26524,44 +26609,75 @@ "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" } ], "type": "list" }, - { - "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": "Region Id in which portable ip range is provisioned", "name": "regionid", "type": "integer" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + } ] }, { @@ -26581,8 +26697,14 @@ "related": "", "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 ID of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -26591,17 +26713,11 @@ "type": "string" }, { - "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.4" }, @@ -26618,14 +26734,6 @@ "required": true, "type": "uuid" }, - { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "list" - }, { "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -26640,30 +26748,38 @@ "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {} ], "since": "4.17.0" @@ -26674,10 +26790,17 @@ "name": "listConfigurations", "params": [ { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -26689,6 +26812,13 @@ "required": false, "type": "uuid" }, + { + "description": "lists configuration by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "lists configurations by category", "length": 255, @@ -26697,19 +26827,20 @@ "type": "string" }, { - "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": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the Cluster to update the parameter value for corresponding cluster", @@ -26720,56 +26851,35 @@ "type": "uuid" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists configuration by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "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", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "updateConfiguration", "response": [ { - "description": "the name of the configuration", - "name": "name", + "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 value of the configuration", @@ -26777,23 +26887,19 @@ "type": "long" }, { - "description": "the description of the configuration", - "name": "description", - "type": "string" - }, - { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { @@ -26801,10 +26907,20 @@ "name": "isdynamic", "type": "boolean" }, + { + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, { "description": "the value of the configuration", "name": "value", "type": "string" + }, + { + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" } ] }, @@ -26824,26 +26940,26 @@ ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "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" } ] }, @@ -26870,22 +26986,12 @@ ], "related": "", "response": [ - { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" - }, + {}, { "description": "the ID of the network", "name": "networkid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -26896,21 +27002,31 @@ "name": "ipaddress", "type": "string" }, + { + "description": "the ID of the secondary private IP addr", + "name": "id", + "type": "string" + }, { "description": "the ID of the nic", "name": "nicid", "type": "string" }, - {}, { - "description": "the ID of the vm", - "name": "virtualmachineid", - "type": "string" + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the ID of the vm", + "name": "virtualmachineid", + "type": "string" } ] }, @@ -26919,13 +27035,6 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ - { - "description": "Minimum number of worker nodes in the cluster", - "length": 255, - "name": "minsize", - "required": false, - "type": "long" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -26934,20 +27043,6 @@ "required": true, "type": "uuid" }, - { - "description": "Whether autoscaling is enabled for the cluster", - "length": 255, - "name": "autoscalingenabled", - "required": false, - "type": "boolean" - }, - { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - }, { "description": "the IDs of the nodes to be removed", "length": 255, @@ -26970,28 +27065,65 @@ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" + }, + { + "description": "Maximum number of worker nodes in the cluster", + "length": 255, + "name": "maxsize", + "required": false, + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "length": 255, + "name": "autoscalingenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Minimum number of worker nodes in the cluster", + "length": 255, + "name": "minsize", + "required": false, + "type": "long" } ], "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "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": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + {}, + { + "description": "the 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" }, { @@ -27000,8 +27132,23 @@ "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "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" }, { @@ -27010,38 +27157,33 @@ "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "keypair details", - "name": "keypair", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the 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 Kubernetes cluster", - "name": "name", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -27050,18 +27192,24 @@ "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "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": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { @@ -27069,18 +27217,16 @@ "name": "account", "type": "string" }, - {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, - {}, { "description": "the control nodes count for the Kubernetes cluster", "name": "controlnodes", @@ -27092,19 +27238,19 @@ "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -27112,38 +27258,13 @@ "type": "integer" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "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 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 cluster", - "name": "id", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { @@ -27177,76 +27298,8 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -27254,8 +27307,13 @@ "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -27264,33 +27322,33 @@ "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -27299,63 +27357,68 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -27364,111 +27427,147 @@ "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the version of scripts", + "name": "scriptsversion", "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 project id of the ipaddress", - "name": "projectid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -27477,49 +27576,81 @@ "type": "boolean" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the router", + "name": "name", "type": "string" }, {}, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "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 link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -27528,84 +27659,84 @@ "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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": "role of the domain router", - "name": "role", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" } ] }, @@ -27624,6 +27755,11 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -27636,11 +27772,6 @@ "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", @@ -27653,6 +27784,13 @@ "isasync": false, "name": "deleteHost", "params": [ + { + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the host ID", "length": 255, @@ -27661,13 +27799,6 @@ "required": true, "type": "uuid" }, - { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, @@ -27677,17 +27808,6 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -27698,7 +27818,18 @@ "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" + }, + {} ] }, { @@ -27726,6 +27857,7 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -27736,7 +27868,6 @@ "name": "displaytext", "type": "string" }, - {}, {} ] }, @@ -27746,33 +27877,31 @@ "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": "the current status of the latest async job acting 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", @@ -27782,7 +27911,9 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {}, + {} ], "since": "4.16.0.0" }, @@ -27794,70 +27925,65 @@ "related": "", "response": [ { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", "type": "boolean" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "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 is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" - }, - { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, - {}, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", - "type": "boolean" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "version of the cloud stack", @@ -27865,20 +27991,9 @@ "type": "string" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" - }, - {}, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "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 region supports elastic load balancer on basic zones", @@ -27886,13 +28001,13 @@ "type": "string" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { @@ -27901,49 +28016,26 @@ "type": "string" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" - } - ] - }, - { - "description": "Release dedication of zone", - "isasync": true, - "name": "releaseDedicatedZone", - "params": [ - { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "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 user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", + "type": "boolean" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" + }, + {} ] }, { @@ -27952,26 +28044,25 @@ "name": "updateTrafficType", "params": [ { - "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 Hyperv host", "length": 255, - "name": "ovm3networklabel", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "xennetworklabel", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "traffic type id", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "ovm3networklabel", + "required": false, + "type": "string" }, { "description": "The network name label of the physical device dedicated to this traffic on a VMware host", @@ -27981,56 +28072,53 @@ "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" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "traffic type id", "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" } ], "related": "addTrafficType", "response": [ { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", "name": "hypervnetworklabel", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "id of the network provider", + "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 network name label of the physical device dedicated to this traffic on a VMware host", @@ -28039,8 +28127,8 @@ }, {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -28048,58 +28136,95 @@ "name": "xennetworklabel", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "List Conditions for the specific user", - "isasync": false, - "name": "listConditions", + { + "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", + "isasync": true, + "name": "releaseDedicatedZone", "params": [ { - "description": "", + "description": "the ID of the Zone", "length": 255, - "name": "page", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "List Conditions for the specific user", + "isasync": false, + "name": "listConditions", + "params": [ + { + "description": "Counter-id of the condition.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "counterid", + "related": "createCounter,listCounters", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "Counter-id of the condition.", + "description": "ID of the Condition.", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "id", + "related": "createCondition,listConditions", "required": false, "type": "uuid" }, { - "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": "the ID of the policy", @@ -28110,50 +28235,51 @@ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "ID of the Condition.", + "description": "", "length": 255, - "name": "id", - "related": "createCondition,listConditions", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createCondition", "response": [ { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { "description": "the domain name of the owner.", @@ -28161,40 +28287,45 @@ "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "list" - }, - { - "description": "the project name of the Condition", - "name": "project", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, + {}, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the id of the Condition", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "list" } ] }, @@ -28203,13 +28334,6 @@ "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": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, @@ -28224,56 +28348,63 @@ "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": true, "type": "uuid" + }, + { + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" } ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ - {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, {}, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -28283,10 +28414,18 @@ "isasync": false, "name": "listManagementServersMetrics", "params": [ + { + "description": "include system level stats", + "length": 255, + "name": "system", + "related": "listManagementServersMetrics", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -28298,13 +28437,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the name of the management server", "length": 255, @@ -28320,81 +28452,80 @@ "type": "string" }, { - "description": "include system level stats", + "description": "", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "", "response": [ { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "The number of terminated threads", + "name": "threadsteminatedcount", "type": "integer" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" }, { - "description": "the current cpu load", - "name": "cpuload", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, - {}, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "the ID of the management server", + "name": "id", + "type": "string" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", "type": "long" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" }, { "description": "the time these statistics were collected", @@ -28402,54 +28533,49 @@ "type": "date" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "the current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" - }, - { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", + "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "Amount of memory used", + "name": "systemmemoryused", + "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { "description": "the running OS kernel version for this Management Server", @@ -28457,25 +28583,25 @@ "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, {}, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { "description": "the state of the management server", @@ -28483,34 +28609,39 @@ "type": "state" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Total system memory", + "name": "systemmemorytotal", + "type": "string" }, { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" + }, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", + "description": "the number of processors available to the JVM", + "name": "availableprocessors", "type": "integer" }, { - "description": "the version of the management server", - "name": "version", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" } ], "since": "4.17.0" @@ -28528,14 +28659,6 @@ "since": "4.4", "type": "map" }, - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, { "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, @@ -28543,15 +28666,17 @@ "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": "the current status of the latest async job acting on this object", @@ -28563,6 +28688,12 @@ "name": "displaytext", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -28576,61 +28707,60 @@ "name": "listInstanceGroups", "params": [ { - "description": "list instance groups by ID", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "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 only resources belonging to the domain specified", + "description": "list instance groups by ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -28642,34 +28772,36 @@ "type": "string" }, { - "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" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" }, { "description": "the project name of the instance group", @@ -28677,35 +28809,34 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the ID of the instance group", - "name": "id", + "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 domain name of the instance group", - "name": "domain", + "description": "the ID of the instance group", + "name": "id", "type": "string" } ] @@ -28715,13 +28846,6 @@ "isasync": true, "name": "migrateSecondaryStorageData", "params": [ - { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", - "length": 255, - "name": "migrationtype", - "required": false, - "type": "string" - }, { "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", "length": 255, @@ -28737,16 +28861,24 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" + }, + { + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { "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", @@ -28766,8 +28898,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ], "since": "4.15.0" }, @@ -28777,36 +28908,72 @@ "name": "createStaticRoute", "params": [ { - "description": "the gateway id we are creating static route for", + "description": "static route cidr", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", + "name": "cidr", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "static route cidr", + "description": "the gateway id we are creating static route for", "length": 255, - "name": "cidr", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listStaticRoutes", "response": [ + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, {}, + {}, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -28815,13 +28982,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -28830,46 +28997,26 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "tag key name", "name": "key", "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" } ], "type": "list" }, { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of static route", - "name": "id", - "type": "string" - }, - { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the state of the static route", + "name": "state", "type": "string" }, { @@ -28878,40 +29025,24 @@ "type": "integer" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the ID of static route", + "name": "id", "type": "string" }, - {}, { "description": "the project name of the static route", "name": "project", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the state of the static route", - "name": "state", + "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 domain associated with the static route", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -28920,14 +29051,6 @@ "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, @@ -28935,34 +29058,42 @@ "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" + }, + { + "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { "description": "the date the volume was attached to a VM instance", @@ -28970,244 +29101,137 @@ "type": "date" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - {}, - { - "description": "the 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": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, { "description": "the disk utilization", "name": "utilization", "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", + "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" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "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", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "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": "true if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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" }, { @@ -29216,52 +29240,52 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project 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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { "description": "provisioning type used to create volumes.", @@ -29269,48 +29293,69 @@ "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "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 account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -29319,14 +29364,100 @@ "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + {}, + { + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "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": "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": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" } ], "since": "4.14.0" @@ -29337,37 +29468,44 @@ "name": "addTrafficType", "params": [ { - "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 trafficType to be added to the physical network", "length": 255, - "name": "isolationmethod", + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "hypervnetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "vlan", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "xennetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 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": "ovm3networklabel", + "name": "isolationmethod", "required": false, "type": "string" }, @@ -29380,78 +29518,71 @@ "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" - }, - { - "description": "the trafficType to be added to the physical network", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" } ], "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 trafficType to be added to the physical network", - "name": "traffictype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, {}, { - "description": "The network name label of the physical device dedicated to this traffic on a 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": "id of the network provider", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the network provider", + "name": "id", + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, {} @@ -29473,28 +29604,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + { + "description": "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" + } ] }, { @@ -29503,11 +29634,12 @@ "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { "description": "", @@ -29517,59 +29649,58 @@ "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": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "lbvmips", + "name": "applied", "required": false, "type": "boolean" }, { - "description": "the ID of the load balancer rule", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "lbvmips", + "required": false, + "type": "boolean" } ], "related": "listLoadBalancerRuleInstances", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "IP addresses of the vm set of lb rule", "name": "lbvmipaddresses", "type": "list" }, - {}, - {}, + { + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ] }, { @@ -29587,11 +29718,6 @@ } ], "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", @@ -29603,6 +29729,11 @@ "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", @@ -29616,13 +29747,6 @@ "isasync": false, "name": "updateDomain", "params": [ - { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, { "description": "ID of domain to update", "length": 255, @@ -29637,40 +29761,46 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" } ], "related": "createDomain,listDomainChildren,listDomains,listDomains", "response": [ - { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" - }, - {}, { "description": "the total memory (in MB) the domain can own", "name": "memorylimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "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": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { "description": "the total number of projects being administrated by this domain", @@ -29678,44 +29808,49 @@ "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "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" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { "description": "the total number of networks owned by domain", @@ -29723,18 +29858,8 @@ "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { @@ -29743,103 +29868,99 @@ "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "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 cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "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 total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { "description": "the total primary storage space (in GiB) available to be used for this domain", "name": "primarystorageavailable", "type": "string" }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, { "description": "the path of the domain", "name": "path", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "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": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, { @@ -29848,54 +29969,64 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, - {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" } ] @@ -29920,12 +30051,11 @@ "type": "string" }, { - "description": "physical network id", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "networkspeed", + "required": false, + "type": "string" }, { "description": "Enabled/Disabled", @@ -29935,23 +30065,30 @@ "type": "string" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "physical network id", "length": 255, - "name": "networkspeed", - "required": false, - "type": "string" + "name": "id", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "createPhysicalNetwork", "response": [ + {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, {}, @@ -29966,24 +30103,23 @@ "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the physical network", + "name": "name", + "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the physical network", + "name": "state", "type": "string" }, { @@ -29992,18 +30128,13 @@ "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -30031,20 +30162,14 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain ID of the vm profile", + "name": "domainid", "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", @@ -30052,63 +30177,59 @@ "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": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "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 frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "the project name of the vm profile", - "name": "project", + "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 current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { @@ -30116,6 +30237,16 @@ "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", + "type": "string" + }, {} ] }, @@ -30125,26 +30256,26 @@ "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": "Map of tags (key/value pairs)", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "timezone", + "required": true, + "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, - "name": "intervaltype", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "maximum number of snapshots to retain", @@ -30162,34 +30293,29 @@ "type": "uuid" }, { - "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": "Map of tags (key/value pairs)", "length": 255, - "name": "schedule", - "required": true, - "type": "string" + "name": "tags", + "required": false, + "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" } ], "related": "updateSnapshotPolicy", "response": [ - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -30198,13 +30324,13 @@ "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 key name", + "name": "key", "type": "string" }, { @@ -30213,8 +30339,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -30223,48 +30349,42 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the 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" } ], "type": "set" }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "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": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { "description": "the ID of the disk volume", @@ -30272,20 +30392,31 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, + {}, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "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" } ] }, @@ -30315,7 +30446,6 @@ "type": "boolean" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -30325,7 +30455,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.11" }, @@ -30334,13 +30465,6 @@ "isasync": false, "name": "createRolePermission", "params": [ - { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The API name or wildcard rule such as list*", "length": 255, @@ -30349,31 +30473,44 @@ "type": "string" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "ID of the role", "length": 255, - "name": "permission", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": true, + "type": "uuid" + }, + { + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "ID of the role", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "permission", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listRolePermissions", "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 name of the role to which the role permission belongs", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the role permission", + "name": "description", "type": "string" }, { @@ -30381,6 +30518,7 @@ "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -30397,17 +30535,10 @@ "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" - }, - {}, - {} + } ], "since": "4.9.0" }, @@ -30417,19 +30548,21 @@ "name": "listSystemVms", "params": [ { - "description": "the ID of the system VM", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "3.0.1", "type": "uuid" }, { - "description": "", + "description": "the Zone ID of the system VM", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the name of the system VM", @@ -30439,57 +30572,48 @@ "type": "string" }, { - "description": "the Pod ID of the system VM", + "description": "the ID of the system VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the storage ID where vm's volumes belong to", + "description": "the Pod ID of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "since": "3.0.1", "type": "uuid" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the state of the system VM", "length": 255, - "name": "systemvmtype", + "name": "state", "required": false, "type": "string" }, { - "description": "the state of the system VM", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "keyword", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "the 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 host ID of the system VM", @@ -30498,68 +30622,81 @@ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "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 system VM type", - "name": "systemvmtype", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, + {}, { "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 systemvm agent version", - "name": "version", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -30568,74 +30705,75 @@ "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "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 first DNS for the system VM", - "name": "dns1", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "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 hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { "description": "the public MAC address for the system VM", @@ -30643,15 +30781,14 @@ "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { "description": "the template name for the system VM", @@ -30659,44 +30796,38 @@ "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 system VM type", + "name": "systemvmtype", "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the 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", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the systemvm agent version", + "name": "version", "type": "string" } ] @@ -30706,15 +30837,6 @@ "isasync": true, "name": "createProject", "params": [ - { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "since": "4.15.0", - "type": "uuid" - }, { "description": "account who will be Admin for the project", "length": 255, @@ -30729,6 +30851,15 @@ "required": true, "type": "string" }, + { + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "since": "4.15.0", + "type": "uuid" + }, { "description": "display text of the project", "length": 255, @@ -30756,69 +30887,136 @@ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "response": [ { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "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 state of the project", - "name": "state", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total 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 project account name of the project", - "name": "projectaccountname", + "description": "the domain name where the project 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 cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the state of the project", + "name": "state", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { "description": "the total memory (in MB) owned by project", @@ -30826,54 +31024,49 @@ "type": "long" }, { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "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" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, + {}, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "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 id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { @@ -30882,19 +31075,14 @@ "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the current status of the latest async job acting on this object", @@ -30902,152 +31090,95 @@ "type": "integer" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { "description": "the total number of templates available to be created by this project", "name": "templateavailable", "type": "string" }, + {}, { - "description": "the name of the project", - "name": "name", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "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 memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the 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 public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "the 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 displaytext of the project", + "name": "displaytext", + "type": "string" }, - {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "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 domain id the project belongs to", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -31058,35 +31189,30 @@ "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,createIpv6FirewallRule,updateIpv6FirewallRule", + "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" } ], "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", @@ -31096,6 +31222,11 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -31104,14 +31235,6 @@ "isasync": false, "name": "addCiscoVnmcResource", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, @@ -31126,6 +31249,14 @@ "required": true, "type": "string" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "Hostname or ip address of the Cisco VNMC Controller.", "length": 255, @@ -31137,11 +31268,6 @@ "related": "listCiscoVnmcResources", "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, {}, @@ -31152,7 +31278,12 @@ "type": "string" }, {}, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -31160,6 +31291,13 @@ "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, @@ -31175,117 +31313,134 @@ "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,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "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": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { "description": "ID of the availability zone", @@ -31293,22 +31448,57 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -31317,28 +31507,28 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -31347,127 +31537,117 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "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", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "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": " 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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -31476,14 +31656,9 @@ "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -31491,54 +31666,35 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, + {}, { - "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": "id of the virtual machine", @@ -31546,33 +31702,8 @@ "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" } ] @@ -31582,14 +31713,6 @@ "isasync": true, "name": "replaceNetworkACLList", "params": [ - { - "description": "the ID of the private gateway", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": false, - "type": "uuid" - }, { "description": "the ID of the network ACL", "length": 255, @@ -31605,31 +31728,39 @@ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" + }, + { + "description": "the ID of the private gateway", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": false, + "type": "uuid" } ], "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" - } + }, + {} ] }, { @@ -31638,10 +31769,10 @@ "name": "markDefaultZoneForAccount", "params": [ { - "description": "The Zone ID with which the account is to be marked.", + "description": "Marks the account that belongs to the specified domain.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": true, "type": "uuid" }, @@ -31654,10 +31785,10 @@ "type": "string" }, { - "description": "Marks the account that belongs to the specified domain.", + "description": "The Zone ID with which the account is to be marked.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } @@ -31665,38 +31796,28 @@ "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "response": [ { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { @@ -31705,13 +31826,18 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -31720,114 +31846,98 @@ "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "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 volume available for this account", - "name": "volumeavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "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": "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": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -31835,28 +31945,23 @@ "name": "user", "response": [ { - "description": "the api key of the user", - "name": "apikey", - "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 account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -31865,28 +31970,28 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -31905,23 +32010,8 @@ "type": "resourceiconresponse" }, { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -31930,8 +32020,13 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -31939,84 +32034,113 @@ "name": "iscallerchilddomain", "type": "boolean" }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the ID of the role", "name": "roleid", "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" } ], "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "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 number of projects the account can own", - "name": "projectlimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the state of the account", + "name": "state", + "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "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 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", @@ -32024,64 +32148,71 @@ "type": "long" }, { - "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 total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, + {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" } ], "since": "4.0" @@ -32103,38 +32234,29 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "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 driver for the host", - "name": "driver", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the operation result description", - "name": "description", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -32142,16 +32264,15 @@ "name": "password", "type": "string" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management interface username", @@ -32159,15 +32280,25 @@ "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 interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" } ], "since": "4.9.0" @@ -32178,52 +32309,62 @@ "name": "listLdapUsers", "params": [ { - "description": "List by keyword", + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", "length": 255, - "name": "keyword", + "name": "userfilter", "required": false, + "since": "4.13", "type": "string" }, { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "description": "List by keyword", "length": 255, - "name": "listtype", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "linked domain", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "description": "", "length": 255, - "name": "userfilter", + "name": "pagesize", "required": false, - "since": "4.13", - "type": "string" + "type": "integer" }, { - "description": "linked domain", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "listtype", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + { + "description": "The user's email", + "name": "email", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", @@ -32231,13 +32372,13 @@ "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's principle", + "name": "principal", "type": "string" }, {}, @@ -32247,28 +32388,18 @@ "type": "string" }, { - "description": "The user's username", - "name": "username", - "type": "string" - }, - { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The user's email", - "name": "email", + "description": "The user's lastname", + "name": "lastname", "type": "string" } ], @@ -32280,16 +32411,16 @@ "name": "revokeCertificate", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "The certificate CN", "length": 255, - "name": "provider", + "name": "cn", "required": false, "type": "string" }, { - "description": "The certificate CN", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "cn", + "name": "provider", "required": false, "type": "string" }, @@ -32302,28 +32433,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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.11.0" }, @@ -32332,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, @@ -32340,13 +32478,6 @@ "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": "The ID of the system vm", "length": 255, @@ -32359,30 +32490,41 @@ "related": "migrateSystemVm,startSystemVm", "response": [ { - "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 agent state of the system VM", - "name": "agentstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 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", @@ -32394,99 +32536,99 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "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", + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "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 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 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 name of the system VM", + "name": "name", "type": "string" }, + {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -32495,13 +32637,8 @@ "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { @@ -32510,50 +32647,44 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, - {}, { - "description": "the state of the system VM", - "name": "state", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" } ] }, @@ -32563,25 +32694,25 @@ "name": "updateSiocInfo", "params": [ { - "description": "Shares per GB", + "description": "Storage Pool ID", "length": 255, - "name": "sharespergb", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "Zone ID", + "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" }, @@ -32593,31 +32724,31 @@ "type": "integer" }, { - "description": "Limit IOPS per GB", + "description": "Shares per GB", "length": 255, - "name": "limitiopspergb", + "name": "sharespergb", "required": true, "type": "integer" } ], "related": "", "response": [ - {}, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {} ], "since": "4.11.0" @@ -32627,13 +32758,6 @@ "isasync": false, "name": "listIpForwardingRules", "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "Lists all rules applied to the specified VM.", "length": 255, @@ -32643,63 +32767,62 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list the rule belonging to this public IP address", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "page", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "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,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "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": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "account", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -32708,60 +32831,73 @@ "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,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", "response": [ { - "description": "the state of the rule", - "name": "state", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "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 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 ID of the port forwarding rule", - "name": "id", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, {}, - {}, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -32769,23 +32905,13 @@ "name": "virtualmachinedisplayname", "type": "string" }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -32798,14 +32924,24 @@ "name": "resourceid", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -32818,48 +32954,43 @@ "name": "projectid", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the UUID of the latest async job acting on 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", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the 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" } ] }, @@ -32869,12 +33000,27 @@ "name": "createSnapshot", "params": [ { - "description": "quiesce vm if true", + "description": "asynchronous backup if true", "length": 255, - "name": "quiescevm", + "name": "asyncbackup", "required": false, "type": "boolean" }, + { + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "length": 255, + "name": "policyid", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Map of tags (key/value pairs)", "length": 255, @@ -32891,18 +33037,19 @@ "type": "uuid" }, { - "description": "asynchronous backup if true", + "description": "quiesce vm if true", "length": 255, - "name": "asyncbackup", + "name": "quiescevm", "required": false, "type": "boolean" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", @@ -32912,85 +33059,69 @@ "type": "string" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", - "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the snapshot", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" - }, - { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { "description": "id of the os on volume", @@ -32998,8 +33129,18 @@ "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "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 disk volume", + "name": "volumeid", "type": "string" }, { @@ -33008,41 +33149,41 @@ "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, + {}, { - "description": "the type of the snapshot", - "name": "snapshottype", - "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", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, - {}, { "description": "the list of resource tags associated", "name": "tags", @@ -33058,64 +33199,54 @@ "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 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": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - } + {} ] }, { @@ -33133,28 +33264,28 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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" - } + {}, + {} ], "since": "4.2.0" }, @@ -33164,25 +33295,24 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the name of the storage pool", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -33194,78 +33324,79 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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": "the name of the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the IP address for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the storage pool", "length": 255, - "name": "keyword", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "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": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { @@ -33274,34 +33405,28 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { @@ -33315,69 +33440,60 @@ "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the storage pool type", + "name": "type", "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 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", @@ -33390,44 +33506,59 @@ "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", + "type": "string" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" } ], @@ -33449,12 +33580,10 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" }, { "description": "result of the unmanage VM operation", @@ -33467,10 +33596,12 @@ "type": "string" }, { - "description": "details of the unmanage VM operation", - "name": "details", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ], "since": "4.15.0" }, @@ -33479,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, @@ -33494,126 +33617,52 @@ "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 second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "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 gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "role of the domain router", - "name": "role", - "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", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of template", + "name": "version", "type": "string" }, { @@ -33621,25 +33670,19 @@ "name": "vpcname", "type": "string" }, - {}, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -33648,13 +33691,13 @@ "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -33663,15 +33706,25 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "type": "string" }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the state of the router", "name": "state", @@ -33683,128 +33736,48 @@ "type": "boolean" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "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 list of nics associated with the router", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 if available", + "name": "isolatedpvlan", + "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 the nic", - "name": "gateway", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "Type of adapter if available", @@ -33812,23 +33785,28 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -33837,33 +33815,38 @@ "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ip address of the nic", + "name": "ipaddress", "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 type if available", - "name": "isolatedpvlantype", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -33872,20 +33855,15 @@ "type": "boolean" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", @@ -33897,14 +33875,19 @@ "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": "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" @@ -33914,20 +33897,178 @@ "name": "redundantstate", "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": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, { "description": "the id of the router", "name": "id", "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "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 host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "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 domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "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" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" } ] }, @@ -33936,21 +34077,6 @@ "isasync": false, "name": "listNics", "params": [ - { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -33974,6 +34100,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -33981,6 +34114,14 @@ "required": false, "type": "integer" }, + { + "description": "list nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, { "description": "the ID of the vm", "length": 255, @@ -33993,23 +34134,23 @@ "related": "", "response": [ { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -34017,35 +34158,34 @@ "name": "jobid", "type": "string" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, - {}, { - "description": "the ID of the nic", - "name": "id", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -34059,14 +34199,19 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "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", @@ -34074,49 +34219,44 @@ "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 ip address of the nic", - "name": "ipaddress", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, + {}, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "ID of the 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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -34125,14 +34265,25 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the nic", + "name": "id", "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ] }, @@ -34141,6 +34292,13 @@ "isasync": false, "name": "createSSHKeyPair", "params": [ + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "an optional project for the ssh key", "length": 255, @@ -34157,13 +34315,6 @@ "required": false, "type": "uuid" }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, @@ -34174,14 +34325,20 @@ ], "related": "", "response": [ + {}, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { @@ -34190,11 +34347,10 @@ "type": "boolean" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "Name of the keypair", + "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -34206,24 +34362,19 @@ "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - { - "description": "Private key", - "name": "privatekey", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" } ] @@ -34260,13 +34411,49 @@ "related": "archiveSnapshot,revertSnapshot", "response": [ { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { @@ -34275,14 +34462,44 @@ "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "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": "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" }, { "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", @@ -34299,23 +34516,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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" }, { @@ -34324,119 +34536,58 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": " the date the snapshot was created", "name": "created", "type": "date" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - {}, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, - {}, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "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" } ], "since": "4.10.0" @@ -34447,25 +34598,41 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "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,updateSecurityGroup", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "account", + "name": "protocol", "required": false, "type": "string" }, { - "description": "TCP is default. UDP is the other supported protocol", + "description": "type of the icmp message being sent", "length": 255, - "name": "protocol", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "end port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { "description": "user to security group mapping", @@ -34475,11 +34642,11 @@ "type": "map" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "start port for this egress rule", "length": 255, - "name": "securitygroupname", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", @@ -34490,19 +34657,18 @@ "type": "uuid" }, { - "description": "an optional project of the security group", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "end port for this egress rule", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "error code for this icmp message", @@ -34512,142 +34678,127 @@ "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "type of the icmp message being sent", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "icmptype", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "authorizeSecurityGroupIngress", "response": [ + {}, { - "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 ending IP of the security group rule ", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + {}, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], @@ -34666,42 +34817,49 @@ "type": "string" }, { - "description": "the name of the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "ipaddress", "required": false, "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": "", + "description": "the storage pool path", "length": 255, - "name": "page", + "name": "path", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the storage pool", @@ -34712,92 +34870,86 @@ "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "the name of the storage pool", "length": 255, - "name": "ipaddress", + "name": "name", "required": false, "type": "string" }, - { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the storage pool path", + "description": "the ID of the storage pool", "length": 255, - "name": "path", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ - {}, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -34805,33 +34957,43 @@ "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": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "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 IP address of the storage pool", - "name": "ipaddress", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { @@ -34840,24 +35002,23 @@ "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -34866,24 +35027,14 @@ "type": "map" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "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" } ] }, @@ -34893,12 +35044,12 @@ "name": "updateHypervisorCapabilities", "params": [ { - "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 ", @@ -34909,27 +35060,18 @@ "type": "integer" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", - "length": 255, - "name": "maxdatavolumeslimit", - "required": false, - "since": "4.16.0", - "type": "integer" - }, - { - "description": "set true to enable storage motion support for this hypervisor", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "storagemotionenabled", + "name": "vmsnapshotenabled", "required": false, "since": "4.16.0", "type": "boolean" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "vmsnapshotenabled", + "name": "securitygroupenabled", "required": false, - "since": "4.16.0", "type": "boolean" }, { @@ -34940,40 +35082,49 @@ "type": "long" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "ID of the hypervisor capability", "length": 255, - "name": "securitygroupenabled", + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "length": 255, + "name": "maxdatavolumeslimit", + "required": false, + "since": "4.16.0", + "type": "integer" } ], "related": "listHypervisorCapabilities", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -34982,13 +35133,13 @@ "type": "boolean" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", "type": "integer" }, { @@ -35002,9 +35153,9 @@ "type": "long" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" } ], "since": "3.0.0" @@ -35015,11 +35166,11 @@ "name": "findHostsForMigration", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -35037,123 +35188,94 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "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": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "averageload", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "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 resource state of the host", - "name": "resourcestate", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the ID of the host", + "name": "id", "type": "string" }, { @@ -35162,13 +35284,13 @@ "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -35177,54 +35299,65 @@ "type": "status" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated 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 currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + {}, { "description": "the amount of the host's memory currently used", "name": "memoryused", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { "description": "true if the host is disconnected. False otherwise.", @@ -35232,33 +35365,38 @@ "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 host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the cpu average load on the host", + "name": "averageload", "type": "long" }, { @@ -35266,48 +35404,61 @@ "name": "type", "type": "type" }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, { "description": "the amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, - {}, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, - {} + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + } ] }, { @@ -35327,19 +35478,19 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" }, { "description": "The Device State (Enabled/Disabled) of the VSM", @@ -35347,23 +35498,23 @@ "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, { "description": "device id of the Cisco N1KV VSM device", "name": "vsmdeviceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -35376,28 +35527,28 @@ "name": "vsmstoragevlanid", "type": "int" }, + {}, + {}, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" - }, - {} + } ] }, { @@ -35405,6 +35556,14 @@ "isasync": false, "name": "dedicateGuestVlanRange", "params": [ + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "physical network ID of the vlan", "length": 255, @@ -35421,13 +35580,6 @@ "required": false, "type": "uuid" }, - { - "description": "guest vlan range to be dedicated", - "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" - }, { "description": "account who will own the VLAN", "length": 255, @@ -35436,20 +35588,18 @@ "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "guest vlan range to be dedicated", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "vlanrange", + "required": true, + "type": "string" } ], "related": "listDedicatedGuestVlanRanges", "response": [ - {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -35463,15 +35613,22 @@ "type": "long" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", @@ -35483,18 +35640,8 @@ "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { @@ -35502,7 +35649,11 @@ "name": "id", "type": "string" }, - {} + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + } ] }, { @@ -35510,6 +35661,20 @@ "isasync": true, "name": "addNicToVirtualMachine", "params": [ + { + "description": "IP Address for the new network", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "Mac Address for the new network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, { "description": "Virtual Machine ID", "length": 255, @@ -35532,66 +35697,52 @@ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" - }, - { - "description": "Mac Address for the new network", - "length": 255, - "name": "macaddress", - "required": false, - "type": "string" - }, - { - "description": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -35600,13 +35751,13 @@ "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -35615,13 +35766,13 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -35638,28 +35789,121 @@ "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "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 date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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": "Guest vm Boot Type", - "name": "boottype", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -35668,39 +35912,45 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { "description": "the ID of the disk offering of the virtual machine", @@ -35708,177 +35958,443 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", "name": "memoryintfreekbs", "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "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 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 description of the security group", - "name": "description", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the 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": "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": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -35889,8 +36405,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -35904,18 +36420,23 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -35924,753 +36445,851 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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 project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", - "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": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - } - ], - "type": "set" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "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": "the list of resource tags associated", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + } + ] + }, + { + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", + "params": [ + { + "description": "list static routes by vpc id", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list static routes by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list static route by id", + "length": 255, + "name": "id", + "related": "listStaticRoutes", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list static routes by gateway id", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "set" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "type": "list" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "VPC the static route belongs to", + "name": "vpcid", "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 associated with the static route", + "name": "domainid", "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 host for the virtual machine", - "name": "hostname", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the state of the static route", + "name": "state", + "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the account associated with the static route", "name": "account", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "static route CIDR", + "name": "cidr", "type": "string" + } + ] + }, + { + "description": "Lists all public ip addresses", + "isasync": false, + "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": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "List IPs belonging to the VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "lists all public IP addresses by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the virtual network for the IP address", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "list only IPs used for load balancing", + "length": 255, + "name": "forloadbalancing", + "required": false, + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "list only source NAT IP addresses", + "length": 255, + "name": "issourcenat", + "required": false, + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "lists all public IP addresses by zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "lists all public IP addresses associated to the network specified", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "lists all public IP addresses by source network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.13.0", + "type": "uuid" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "lists all public IP addresses by VLAN ID", + "length": 255, + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "limits search results to allocated public IP addresses", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "list only static NAT IP addresses", + "length": 255, + "name": "isstaticnat", + "required": false, + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "lists IP address by ID", + "length": 255, + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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 project id of the vm", - "name": "projectid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": false, - "type": "uuid" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the domain ID the public IP address is associated with", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { - "description": "list static routes by state", - "length": 255, + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", "name": "state", - "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, - {}, - {}, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the list of resource tags associated with static route", + "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": "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 entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -36682,307 +37301,294 @@ "type": "list" }, { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of static route", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" } ] }, { - "description": "Lists all public ip addresses", + "description": "Updates an ISO file.", "isasync": false, - "name": "listPublicIpAddresses", + "name": "updateIso", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the format for the image", "length": 255, - "name": "keyword", + "name": "format", "required": false, "type": "string" }, { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "fordisplay", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only static NAT IP addresses", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isstaticnat", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists the specified IP address", + "description": "the name of the image file", "length": 255, - "name": "ipaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "lists all public IP addresses by zone ID", + "description": "sort key of the template, integer", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "sortkey", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "the ID of the image file", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "pagesize", + "name": "passwordenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "account", + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "isrecursive", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the virtual network for the IP address", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "forvirtualnetwork", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "list only source NAT IP addresses", + "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": "issourcenat", + "name": "cleanupdetails", "required": false, "type": "boolean" - }, + } + ], + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "lists all public IP addresses by source network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", - "type": "uuid" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "list only IPs used for load balancing", - "length": 255, - "name": "forloadbalancing", - "required": false, + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "List IPs belonging to the VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "lists IP address by ID", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - } - ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the account the public IP address is associated with", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", "name": "account", "type": "string" }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, {}, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the list of resource tags associated with ip address", + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the 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": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -36991,350 +37597,312 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], - "type": "list" - }, - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "type": "set" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "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": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", + "description": "the date this template was created", + "name": "created", "type": "date" }, { - "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 domain ID the public IP address is associated with", - "name": "domainid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" } ] }, { - "description": "Updates an ISO file.", + "description": "Lists OpenDyalight controllers", "isasync": false, - "name": "updateIso", + "name": "listOpenDaylightControllers", "params": [ { - "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": "the Physical Network ID", "length": 255, - "name": "cleanupdetails", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, "type": "uuid" + } + ], + "related": "addOpenDaylightController,deleteOpenDaylightController", + "response": [ + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "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": "the username to authenticate to the controller", + "name": "username", + "type": "string" }, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "device id of the controller", + "name": "id", + "type": "string" }, { - "description": "the name of the image file", - "length": 255, + "description": "the name assigned to the controller", "name": "name", - "required": false, "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 url of the controller api", + "name": "url", + "type": "string" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the Physical Network ID", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, - "name": "requireshvm", - "required": false, + "name": "nat", + "required": true, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "Password of the BigSwitch BCF Controller.", "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "hostname", + "required": true, + "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" } ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listBigSwitchBcfDevices", "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": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the 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", + "description": "NAT support", + "name": "nat", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the controller password", + "name": "password", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes a counter", + "isasync": true, + "name": "deleteCounter", + "params": [ { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "the ID of the counter", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "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", @@ -37342,458 +37910,595 @@ }, {}, { - "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 name of the secondary storage host for the template", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Changes the default NIC on a VM", + "isasync": true, + "name": "updateDefaultNicForVirtualMachine", + "params": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + {}, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the 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": "the account name to which the template belongs", - "name": "account", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the template", + "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", + "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 tag of this template", - "name": "templatetag", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" - } - ] - }, - { - "description": "Lists OpenDyalight controllers", - "isasync": false, - "name": "listOpenDaylightControllers", - "params": [ + }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "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": "Adds a BigSwitch BCF Controller device", - "isasync": true, - "name": "addBigSwitchBcfDevice", - "params": [ - { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", - "length": 255, - "name": "hostname", - "required": true, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Password of the BigSwitch BCF Controller.", - "length": 255, - "name": "password", - "required": true, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "NAT support of the BigSwitch BCF Controller.", - "length": 255, - "name": "nat", - "required": true, - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Username of the BigSwitch BCF Controller.", - "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "related": "listBigSwitchBcfDevices", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the controller username", - "name": "username", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the controller password", - "name": "password", - "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Deletes a counter", - "isasync": true, - "name": "deleteCounter", - "params": [ - { - "description": "the ID of the counter", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, - {}, - {} - ] - }, - { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the password (if exists) of the virtual machine", @@ -37801,430 +38506,482 @@ "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "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": "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 value", - "name": "value", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 type of the nic", - "name": "type", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "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 isolation uri of the nic", - "name": "isolationuri", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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 list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the description of the security group", + "name": "description", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" } ], "type": "set" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project 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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, + "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": "the user's name who deployed the virtual machine", - "name": "username", + "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": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", + "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", @@ -38232,527 +38989,160 @@ "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the out-of-band management interface port", + "name": "port", "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 out-of-band management driver for the host", + "name": "driver", + "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - {}, - {}, + "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": "the pool type of the virtual machine", - "name": "pooltype", + "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": "ssh key-pairs", - "name": "keypairs", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, + "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The client certificate", + "name": "certificate", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Private key for the certificate", + "name": "privatekey", "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 CA certificate(s)", + "name": "cacertificates", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - {}, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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 group", - "name": "project", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11.0" }, { - "description": "Deletes a user for an account", + "description": "Deletes network device.", "isasync": false, - "name": "deleteUser", + "name": "deleteNetworkDevice", "params": [ { - "description": "id of the user to be deleted", + "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "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", @@ -38767,97 +39157,73 @@ "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": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", + "description": "Updates image store read-only status", + "isasync": false, + "name": "updateImageStore", "params": [ { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "description": "Image Store UUID", "length": 255, - "name": "action", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "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" + "type": "uuid" }, { - "description": "the ID of the host", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "readonly", "required": true, - "type": "uuid" + "type": "boolean" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", + "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the provider name of the image store", + "name": "providername", "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 ID of the host", - "name": "hostid", + "description": "the Zone ID of the image store", + "name": "zoneid", "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "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", @@ -38865,224 +39231,29 @@ "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", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Issues a client certificate using configured or provided CA plugin", - "isasync": true, - "name": "issueCertificate", - "params": [ - { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, - { - "description": "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": "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" - } - ], - "related": "listCaCertificate", - "response": [ - { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The client certificate", - "name": "certificate", - "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" - }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", - "params": [ - { - "description": "Id of network device to delete", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the 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": "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 Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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 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" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - {}, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the image store", "name": "name", "type": "string" }, - {}, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" } ], "since": "4.15.0" @@ -39093,11 +39264,18 @@ "name": "createPortForwardingRule", "params": [ { - "description": "the starting port of port forwarding rule's public port range", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "publicport", + "name": "vmguestip", + "required": false, + "type": "string" + }, + { + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", @@ -39107,174 +39285,110 @@ "type": "boolean" }, { - "description": "the IP address id of the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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": "privateendport", + "name": "publicendport", "required": false, "type": "integer" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "protocol", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "the starting port of port forwarding rule's public port range", "length": 255, - "name": "publicendport", - "required": false, + "name": "publicport", + "required": true, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the starting port of port forwarding rule's private port range", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "privateport", + "required": true, + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "cidrlist", + "name": "privateendport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "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": "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, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "VM guest nic secondary IP address for the port forwarding 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": "vmguestip", + "name": "cidrlist", "required": false, - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "type": "list" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" } ], - "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "response": [ - { - "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", - "type": "string" - }, - {}, { "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "name": "publicendport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, - {}, { "description": "the public ip address for the port forwarding rule", "name": "ipaddress", "type": "string" }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", "type": "string" }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -39290,13 +39404,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -39305,8 +39414,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -39315,8 +39424,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -39325,86 +39434,73 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ + }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "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", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + {}, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "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 Name of the Zone", - "name": "zonename", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" } ] @@ -39414,14 +39510,6 @@ "isasync": false, "name": "prepareTemplate", "params": [ - { - "description": "zone ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, @@ -39437,168 +39525,176 @@ "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 date this template was removed", - "name": "removed", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "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 ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the 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", + "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "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": "the template display text", - "name": "displaytext", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, + {}, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "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": "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -39607,67 +39703,87 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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 ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "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": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" }, { "description": "the URL which the template/iso is registered from", @@ -39675,75 +39791,130 @@ "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "checksum of the template", "name": "checksum", "type": "string" }, + {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -39752,14 +39923,6 @@ "isasync": true, "name": "assignToLoadBalancerRule", "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, { "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, @@ -39768,6 +39931,14 @@ "since": "4.4", "type": "map" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "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, @@ -39778,10 +39949,14 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -39789,16 +39964,12 @@ "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" - }, {} ] }, @@ -39807,20 +39978,6 @@ "isasync": false, "name": "listAsyncJobs", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -39836,6 +39993,13 @@ "required": false, "type": "boolean" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, @@ -39843,6 +40007,13 @@ "required": false, "type": "boolean" }, + { + "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": "List by keyword", "length": 255, @@ -39851,36 +40022,32 @@ "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "tzdate" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { "description": " the created date of the job", @@ -39888,11 +40055,26 @@ "type": "date" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, {}, + { + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + { + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" + }, + { + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" + }, { "description": " the completed date of the job", "name": "completed", @@ -39904,25 +40086,14 @@ "type": "integer" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account that executed the async command", @@ -39935,9 +40106,9 @@ "type": "integer" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" } ] }, @@ -39979,9 +40150,9 @@ "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", @@ -39989,15 +40160,15 @@ "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" } ] }, @@ -40016,23 +40187,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": "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", @@ -40064,151 +40235,34 @@ "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the project name of the address", + "name": "project", + "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 date and time the router was created", - "name": "created", - "type": "date" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "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": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the 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 first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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 link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -40217,23 +40271,18 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -40242,97 +40291,82 @@ "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ip address of the nic", + "name": "ipaddress", "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -40341,43 +40375,43 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -40385,42 +40419,149 @@ "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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" } ], "type": "set" }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "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 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 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": "role of the domain router", "name": "role", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { @@ -40429,13 +40570,38 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -40444,54 +40610,69 @@ "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 public IP address for the router", - "name": "publicip", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + {}, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" } ] @@ -40516,28 +40697,29 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listBrocadeVcsDevices", "response": [ { - "description": "the principal switch Ip address", - "name": "hostname", + "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", @@ -40549,14 +40731,13 @@ "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, - {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -40564,12 +40745,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "device name", + "name": "brocadedevicename", "type": "string" - }, - {} + } ] }, { @@ -40603,97 +40784,30 @@ ], "related": "createSecurityGroup", "response": [ - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -40701,18 +40815,8 @@ "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -40721,18 +40825,8 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -40741,52 +40835,47 @@ "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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -40798,45 +40887,157 @@ "description": "id of the resource", "name": "resourceid", "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, + { + "description": "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 project name of the group", + "name": "project", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the 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" }, { @@ -40844,53 +41045,48 @@ "name": "icmpcode", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -40899,47 +41095,32 @@ "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": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, - { - "description": "the 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", - "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" - } + {} ], "since": "4.14.0.0" }, @@ -40949,56 +41130,70 @@ "name": "createDomain", "params": [ { - "description": "creates domain with this name", + "description": "Domain UUID, required for adding domain from another Region", "length": 255, - "name": "name", - "required": true, + "name": "domainid", + "required": false, "type": "string" }, { - "description": "Network domain for networks in the domain", + "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": "networkdomain", + "name": "parentdomainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Domain UUID, required for adding domain from another Region", + "description": "Network domain for networks in the domain", "length": 255, - "name": "domainid", + "name": "networkdomain", "required": false, "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": "creates domain with this name", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" } ], "related": "listDomainChildren,listDomains,listDomains", "response": [ - {}, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { @@ -41007,63 +41202,64 @@ "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 number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, + {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { @@ -41071,86 +41267,80 @@ "name": "vmtotal", "type": "long" }, - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "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 available to be created for this domain", "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "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": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "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", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { "description": "the total number of virtual machines that can be deployed by this domain", @@ -41163,18 +41353,18 @@ "type": "boolean" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { @@ -41183,58 +41373,49 @@ "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "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 templates which can be created by this domain", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "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 number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" } ] @@ -41244,13 +41425,6 @@ "isasync": true, "name": "deleteTags", "params": [ - { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "Delete tags for resource id(s)", "length": 255, @@ -41258,6 +41432,13 @@ "required": true, "type": "list" }, + { + "description": "Delete tags matching key/value pairs", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "Delete tag by resource type", "length": 255, @@ -41267,6 +41448,12 @@ } ], "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", @@ -41277,18 +41464,12 @@ "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.0.0" }, @@ -41297,24 +41478,17 @@ "isasync": false, "name": "listExternalFirewalls", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -41325,28 +41499,35 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the ID of the network device", + "name": "id", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { @@ -41355,15 +41536,13 @@ "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {}, - {}, { - "description": "the 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" }, { @@ -41372,35 +41551,37 @@ "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 private security zone of the external firewall", - "name": "privatezone", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "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 management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the network device", - "name": "id", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" - } + }, + {}, + {} ] }, { @@ -41409,45 +41590,50 @@ "name": "restartNetwork", "params": [ { - "description": "Turn the network into a network with redundant routers.", + "description": "The ID of the network to restart.", "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "If cleanup old network elements", "length": 255, - "name": "livepatch", + "name": "cleanup", "required": false, - "since": "4.17.0", "type": "boolean" }, { - "description": "The ID of the network to restart.", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, { - "description": "If cleanup old network elements", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "cleanup", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" } ], "response": [ - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "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", @@ -41457,11 +41643,6 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -41471,10 +41652,10 @@ "name": "login", "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": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, - "name": "password", - "required": true, + "name": "domain", + "required": false, "type": "string" }, { @@ -41485,10 +41666,10 @@ "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "domain", - "required": false, + "name": "password", + "required": true, "type": "string" }, { @@ -41502,14 +41683,19 @@ "related": "", "response": [ { - "description": "User ID", - "name": "userid", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", @@ -41517,18 +41703,13 @@ "type": "integer" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", - "type": "string" - }, - { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { @@ -41537,18 +41718,13 @@ "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", - "type": "string" - }, - { - "description": "last name of the user", - "name": "lastname", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "Username", + "name": "username", "type": "string" }, { @@ -41556,21 +41732,26 @@ "name": "timezoneoffset", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "User ID", + "name": "userid", "type": "string" }, {}, { - "description": "Username", - "name": "username", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" } ] @@ -41580,20 +41761,6 @@ "isasync": false, "name": "listHypervisorCapabilities", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -41615,30 +41782,44 @@ "related": "listHypervisorCapabilities", "required": false, "type": "uuid" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", "type": "integer" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "true if security group is supported", - "name": "securitygroupenabled", + "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 ID of the hypervisor capabilities row", + "name": "id", + "type": "string" }, { "description": "true if VM snapshots are enabled for this hypervisor", @@ -41646,20 +41827,16 @@ "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 security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", @@ -41671,11 +41848,15 @@ "type": "string" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "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": "3.0.0" }, @@ -41684,6 +41865,13 @@ "isasync": false, "name": "addImageStore", "params": [ + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, { "description": "the name for the image store", "length": 255, @@ -41691,6 +41879,13 @@ "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, + "name": "details", + "required": false, + "type": "map" + }, { "description": "the URL for the image store", "length": 2048, @@ -41698,13 +41893,6 @@ "required": false, "type": "string" }, - { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, { "description": "the Zone ID for the image store", "length": 255, @@ -41712,48 +41900,47 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the image store", + "name": "url", "type": "string" }, + {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, { "description": "the name of the image store", "name": "name", "type": "string" }, - {}, { "description": "defines if store is read-only", "name": "readonly", @@ -41765,31 +41952,25 @@ "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "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 url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { "description": "the scope of the image store", "name": "scope", @@ -41811,11 +41992,11 @@ "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) zone to revoke certificate", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { @@ -41834,21 +42015,27 @@ "type": "uuid" }, { - "description": "(optional) zone to revoke certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "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": "indicates if the certificate has been revoked from the host, failed or skipped", "name": "status", @@ -41859,23 +42046,17 @@ "name": "jobid", "type": "string" }, - { - "description": "the name of the host", - "name": "hostname", - "type": "string" - }, { "description": "indicates the details in case of failure or host skipped", "name": "details", "type": "string" }, - {}, - {}, { "description": "the ID of the host", "name": "hostid", "type": "string" - } + }, + {} ], "since": "4.13" }, @@ -41896,24 +42077,30 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -41921,69 +42108,64 @@ "type": "long" }, { - "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 hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 total disk size of the storage pool", - "name": "disksizetotal", + "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 tags for the storage pool", "name": "tags", "type": "string" }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -41991,51 +42173,50 @@ "name": "state", "type": "storagepoolstatus" }, - {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ], "since": "4.16.0" @@ -42063,28 +42244,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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -42110,6 +42291,11 @@ ], "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", @@ -42121,11 +42307,6 @@ "description": "SolidFire Account ID", "name": "solidFireAccountId", "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -42145,31 +42326,24 @@ ], "related": "", "response": [ - {}, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { @@ -42178,13 +42352,20 @@ "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 api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -42195,6 +42376,13 @@ "isasync": false, "name": "listSupportedNetworkServices", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -42222,31 +42410,42 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -42257,11 +42456,21 @@ "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", @@ -42275,45 +42484,17 @@ ], "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 list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -42332,22 +42513,22 @@ } ], "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the 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", @@ -42364,75 +42545,75 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the dedicated guest vlan range", "length": 255, - "name": "page", + "name": "guestvlanrange", "required": false, - "type": "integer" + "type": "string" }, { - "description": "zone of the guest VLAN range", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "physical network id of the guest VLAN range", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the dedicated guest vlan range", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "guestvlanrange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "id", + "related": "listDedicatedGuestVlanRanges", "required": false, "type": "uuid" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "account", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "zone of the guest VLAN range", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "project who will own the guest VLAN range", + "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" } @@ -42440,18 +42621,24 @@ "related": "", "response": [ { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, + {}, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", + "description": "the zone of the guest vlan range", + "name": "zoneid", "type": "long" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { @@ -42460,40 +42647,34 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, - { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" - }, { "description": "the project id of the guest vlan range", "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" } ] @@ -42504,26 +42685,19 @@ "name": "addNetworkServiceProvider", "params": [ { - "description": "the Physical Network ID to add the provider to", + "description": "the destination Physical Network ID to bridge to", "length": 255, - "name": "physicalnetworkid", + "name": "destinationphysicalnetworkid", "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the destination Physical Network ID to bridge to", + "description": "the Physical Network ID to add the provider to", "length": 255, - "name": "destinationphysicalnetworkid", + "name": "physicalnetworkid", "related": "createPhysicalNetwork", - "required": false, + "required": true, "type": "uuid" }, { @@ -42532,13 +42706,20 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" } ], "related": "listNetworkServiceProviders,listTrafficTypes", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, @@ -42548,40 +42729,40 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the 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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "since": "3.0.0" @@ -42592,18 +42773,12 @@ "name": "listNetworkACLs", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list network ACL items by traffic type - ingress or egress", @@ -42613,112 +42788,128 @@ "type": "string" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network ACL items by ACL ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list network ACL items by network ID", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list network ACL items by network ID", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Lists network ACL Item with the specified ID", + "length": 255, + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, { - "description": "list network ACL items by action", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "action", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list network ACL items by action", "length": 255, - "name": "fordisplay", + "name": "action", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list network ACL items by protocol", "length": 255, - "name": "isrecursive", + "name": "protocol", "required": false, - "type": "boolean" + "type": "string" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -42727,77 +42918,61 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -42811,23 +42986,19 @@ "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { @@ -42835,16 +43006,20 @@ "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" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { "description": "Number of the ACL Item", @@ -42852,9 +43027,15 @@ "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" } ] }, @@ -42874,27 +43055,27 @@ ], "response": [ {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -42903,11 +43084,19 @@ "name": "createServiceOffering", "params": [ { - "description": "min iops of the compute offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "miniops", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", "required": false, - "since": "4.4", "type": "long" }, { @@ -42919,82 +43108,106 @@ "type": "integer" }, { - "description": "whether compute offering iops is custom or not", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "customizediops", + "name": "iopswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "restrict the CPU usage to committed service offering", + "length": 255, + "name": "limitcpuuse", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the Root disk size in GB.", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "rootdisksize", + "name": "byteswriterate", "required": false, - "since": "4.15", "type": "long" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "storagetype", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "string" + "since": "4.4", + "type": "integer" }, { - "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": "long" + }, + { + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the HA for the service offering", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "offerha", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "deploymentplanner", + "name": "maxmemory", "required": false, - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "the CPU number of the service offering", + "description": "the Root disk size in GB.", "length": 255, - "name": "cpunumber", + "name": "rootdisksize", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "is this a system vm offering", + "description": "the HA for the service offering", "length": 255, - "name": "issystem", + "name": "offerha", "required": false, "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "byteswriteratemaxlength", + "name": "memory", "required": false, - "type": "long" + "type": "integer" }, { - "description": "burst requests read rate of the disk offering", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "iopsreadratemax", + "name": "dynamicscalingenabled", "required": false, - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "description": "bytes read rate of the disk offering", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "bytesreadrate", + "name": "systemvmtype", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, @@ -43006,26 +43219,25 @@ "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "networkrate", + "name": "provisioningtype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "iopswriterate", "required": false, "type": "long" }, { - "description": "max iops of the compute offering", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "maxiops", + "name": "networkrate", "required": false, - "since": "4.4", - "type": "long" + "type": "integer" }, { "description": "the ID of the disk offering to which service offering should be mapped", @@ -43037,23 +43249,23 @@ "type": "uuid" }, { - "description": "bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriterate", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "the host tag for this service offering.", "length": 255, - "name": "iopswriteratemaxlength", + "name": "hosttags", "required": false, - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriterate", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, @@ -43065,49 +43277,19 @@ "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": "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": "details for planner, used to store specific parameters", - "length": 255, - "name": "serviceofferingdetails", - "required": false, - "type": "map" - }, - { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "type": "string" - }, - { - "description": "the name of the service offering", + "description": "the display text of the service offering", "length": 255, - "name": "name", + "name": "displaytext", "required": true, "type": "string" }, { - "description": "the tags for this service offering.", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", "length": 255, - "name": "tags", + "name": "diskofferingstrictness", "required": false, - "type": "string" + "since": "4.17", + "type": "boolean" }, { "description": "The minimum memory size of the custom service offering in MB", @@ -43118,19 +43300,19 @@ "type": "integer" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "the tags for this service offering.", "length": 255, - "name": "dynamicscalingenabled", + "name": "tags", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "iopsreadratemaxlength", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "long" + "type": "list" }, { "description": "Whether service offering size is custom or not", @@ -43141,301 +43323,276 @@ "type": "boolean" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the CPU number of the service offering", "length": 255, - "name": "systemvmtype", + "name": "cpunumber", "required": false, - "type": "string" + "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "max iops of the compute offering", "length": 255, - "name": "limitcpuuse", + "name": "maxiops", "required": false, - "type": "boolean" + "since": "4.4", + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "min iops of the compute offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "miniops", "required": false, + "since": "4.4", "type": "long" }, { - "description": "the display text of the service offering", + "description": "is this a system vm offering", "length": 255, - "name": "displaytext", - "required": true, - "type": "string" + "name": "issystem", + "required": false, + "type": "boolean" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "mincpunumber", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "diskofferingstrictness", + "name": "iopsreadrate", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "the CPU speed of the service offering in MHz.", "length": 255, - "name": "maxmemory", + "name": "cpuspeed", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "the total memory of the service offering in MB", + "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": "memory", + "name": "deploymentplanner", "required": false, - "type": "integer" + "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "iopsreadrate", + "name": "serviceofferingdetails", "required": false, - "type": "long" + "type": "map" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "provisioningtype", + "name": "storagetype", "required": false, "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "cpuspeed", + "name": "mincpunumber", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "cachemode", "required": false, - "type": "list" + "since": "4.14", + "type": "string" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "customizediops", "required": false, - "since": "4.15", - "type": "uuid" + "since": "4.4", + "type": "boolean" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ - {}, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, + {}, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the host tag for the service offering", + "name": "hosttags", "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 tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "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", + "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "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 storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "the 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 service offering was created", - "name": "created", - "type": "date" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, + {}, { "description": "additional key/value details tied with this service offering", "name": "serviceofferingdetails", "type": "map" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "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": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { @@ -43444,70 +43601,94 @@ "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, - {}, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "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": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" } ] }, @@ -43516,14 +43697,6 @@ "isasync": true, "name": "copyTemplate", "params": [ - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, { "description": "ID of the zone the template is being copied to.", "length": 255, @@ -43547,44 +43720,53 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" } ], "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, + {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the template name", + "name": "name", + "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 extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "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 current status of the latest async job acting on this object", @@ -43592,56 +43774,55 @@ "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 size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the status of the template", + "name": "status", "type": "string" }, - {}, { "description": "the template ID", "name": "id", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the size of the template", + "name": "size", + "type": "long" }, {}, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -43649,29 +43830,19 @@ "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "true if the template is ready to be deployed from, false otherwise.", @@ -43679,129 +43850,109 @@ "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", + "description": "the date this template was created", + "name": "created", "type": "date" }, { - "description": "the template name", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, { "description": "if Datadisk template, then id of the root disk template this template belongs to", "name": "parenttemplateid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { "description": "the template ID of the parent template if present", "name": "sourcetemplateid", "type": "string" }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, { "description": "true if template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -43818,13 +43969,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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43832,28 +43983,58 @@ "name": "project", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" } ] }, @@ -43862,13 +44043,6 @@ "isasync": false, "name": "listNiciraNvpDeviceNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "nicira nvp device ID", "length": 255, @@ -43877,6 +44051,13 @@ "required": true, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -43885,44 +44066,33 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ - {}, - { - "description": "the id of the network", - "name": "id", - "type": "string" - }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -43931,144 +44101,197 @@ "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, + {}, { "description": "the name of the Network associated with this network", "name": "associatednetwork", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "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": "VPC the network belongs to", - "name": "vpcid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the displaytext of the network", + "name": "displaytext", "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { "description": "an optional field, whether to the display the network to the end user or not.", @@ -44076,33 +44299,29 @@ "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the owner of the network", + "name": "account", "type": "string" }, + {}, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "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 external id of the network", - "name": "externalid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { @@ -44111,117 +44330,64 @@ "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, - {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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 users from subdomains can access the domain level network", @@ -44229,30 +44395,25 @@ "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of services", "name": "service", @@ -44262,14 +44423,14 @@ "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", @@ -44281,37 +44442,32 @@ "name": "name", "type": "string" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "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", @@ -44319,44 +44475,69 @@ "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the traffic type of the network", + "name": "traffictype", "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 routing mode of network offering", + "name": "ip6routing", "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 displaytext of the network", - "name": "displaytext", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" } ] @@ -44366,14 +44547,6 @@ "isasync": false, "name": "assignVirtualMachine", "params": [ - { - "description": "domain id of the new VM owner.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "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, @@ -44382,14 +44555,6 @@ "required": false, "type": "list" }, - { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, { "description": "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, @@ -44412,28 +44577,54 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "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", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -44441,90 +44632,133 @@ "name": "jobid", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, + {}, { "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": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the 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 template for the virtual machine", - "name": "templatedisplaytext", + "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", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { "description": "ssh key-pairs", @@ -44532,13 +44766,19 @@ "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -44547,202 +44787,74 @@ "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" }, { - "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 name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "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" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { "description": "the user's name who deployed the virtual machine", @@ -44750,24 +44862,34 @@ "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -44776,218 +44898,95 @@ "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 description of the affinity group", + "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain ID of the affinity group", + "description": "the domain ID of the security 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": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "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 type of the affinity group", - "name": "type", - "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" - } - ], - "type": "set" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - {}, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -44996,8 +44995,8 @@ "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" }, { @@ -45006,8 +45005,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -45016,78 +45015,155 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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", + "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "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 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 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": "the protocol of the security group rule", - "name": "protocol", + "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" }, { @@ -45095,18 +45171,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -45120,8 +45191,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -45135,179 +45206,299 @@ "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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": "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" - }, + } + ], + "type": "set" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the project name of the group", - "name": "project", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain ID of the security group", - "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the 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": "set" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, { "description": "the password (if exists) of the virtual machine", "name": "password", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -45315,8 +45506,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -45325,8 +45521,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -45334,29 +45530,24 @@ "name": "resourcetype", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -45385,13 +45576,6 @@ } ], "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", @@ -45402,6 +45586,13 @@ "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", @@ -45415,13 +45606,6 @@ "isasync": true, "name": "configureNetscalerLoadBalancer", "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": "Netscaler load balancer device ID", "length": 255, @@ -45431,16 +45615,23 @@ "type": "uuid" }, { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, - "name": "inline", + "name": "lbdevicededicated", "required": false, "type": "boolean" }, { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "lbdevicededicated", + "name": "lbdevicecapacity", + "required": false, + "type": "long" + }, + { + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "length": 255, + "name": "inline", "required": false, "type": "boolean" }, @@ -45455,91 +45646,91 @@ ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, - {}, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device state", + "name": "lbdevicestate", + "type": "string" }, { "description": "device name", "name": "lbdevicename", "type": "string" }, + {}, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", "type": "boolean" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, - {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" } ] @@ -45557,13 +45748,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -45574,10 +45758,17 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, { "description": "list ovs elements by id", "length": 255, @@ -45587,11 +45778,11 @@ "type": "uuid" }, { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "configureOvsElement", @@ -45601,35 +45792,30 @@ "name": "project", "type": "string" }, - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain associated with the provider", "name": "domain", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "description": "the id of the ovs", + "name": "id", "type": "string" }, { @@ -45638,14 +45824,19 @@ "type": "string" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, {} ] @@ -45655,13 +45846,6 @@ "isasync": true, "name": "associateUcsProfileToBlade", "params": [ - { - "description": "profile dn", - "length": 255, - "name": "profiledn", - "required": true, - "type": "string" - }, { "description": "blade id", "length": 255, @@ -45670,6 +45854,13 @@ "required": true, "type": "uuid" }, + { + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, + "type": "string" + }, { "description": "ucs manager id", "length": 255, @@ -45686,39 +45877,87 @@ "name": "hostid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "ucs blade dn", "name": "bladedn", "type": "string" }, + { + "description": "ucs blade id", + "name": "id", + "type": "string" + }, + {}, + { + "description": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" + }, { "description": "associated ucs profile dn", "name": "profiledn", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ] + }, + { + "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": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "ucs blade 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": "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", @@ -45733,11 +45972,11 @@ "type": "string" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "VMware datacenter name.", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", @@ -45747,118 +45986,77 @@ "type": "string" }, { - "description": "The zone ID", + "description": "The password for specified username.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "type": "string" }, { - "description": "VMware datacenter name.", + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The password for specified username.", + "description": "The zone ID", "length": 255, - "name": "password", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "type": "string" - }, { "description": "The VMware Datacenter ID", "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "the Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, - { - "description": "The VMware Datacenter name", - "name": "name", - "type": "string" - } - ], - "since": "4.12.0" - }, - { - "description": "Deletes user from the project", - "isasync": true, - "name": "deleteUserFromProject", - "params": [ - { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "Id of the user to be removed from the project", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "The VMware Datacenter name", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" } ], - "since": "4.15.0" + "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": "the ID of the router", "length": 255, @@ -45866,18 +46064,16 @@ "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "required": true, "type": "uuid" - }, - { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", - "length": 255, - "name": "performfreshchecks", - "required": false, - "type": "boolean" } ], "related": "", "response": [ {}, + { + "description": "the id of the router", + "name": "healthchecks", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -45888,11 +46084,6 @@ "name": "routerid", "type": "string" }, - { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -45908,11 +46099,11 @@ "name": "listNetscalerControlCenter", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -45922,18 +46113,24 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "id", - "name": "id", + "description": "uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "username", + "name": "username", "type": "string" }, {}, @@ -45942,30 +46139,24 @@ "name": "numretries", "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": "ncc_ip", - "name": "ipaddress", + "description": "id", + "name": "id", "type": "string" }, { - "description": "uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "username", - "name": "username", + "description": "ncc_ip", + "name": "ipaddress", "type": "string" } ] @@ -45975,14 +46166,6 @@ "isasync": true, "name": "resizeVolume", "params": [ - { - "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": "Verify OK to Shrink", "length": 255, @@ -45990,13 +46173,6 @@ "required": false, "type": "boolean" }, - { - "description": "New maximum number of IOPS", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, { "description": "New volume size in GB", "length": 255, @@ -46005,9 +46181,9 @@ "type": "long" }, { - "description": "New minimum number of IOPS", + "description": "New maximum number of IOPS", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "type": "long" }, @@ -46018,87 +46194,214 @@ "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "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" + }, { "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 path of the volume", - "name": "path", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "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 status of the volume", - "name": "status", + "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": "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -46107,62 +46410,72 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "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", @@ -46170,59 +46483,63 @@ "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -46231,34 +46548,34 @@ "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { "description": "the chain info of the volume", @@ -46266,94 +46583,13 @@ "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - {}, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "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": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -46362,54 +46598,9 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" } ] }, @@ -46419,17 +46610,10 @@ "name": "deleteAffinityGroup", "params": [ { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the project of the affinity group", "length": 255, - "name": "id", - "related": "", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -46442,12 +46626,11 @@ "type": "uuid" }, { - "description": "the project of the affinity group", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The name of the affinity group. Mutually exclusive with ID parameter", @@ -46455,30 +46638,38 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -46504,20 +46695,20 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -46537,105 +46728,30 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", - "params": [ - { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedPods", - "response": [ - { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, {}, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" - }, - { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" } - ] + ], + "since": "3.0.0" }, { "description": "List network devices", @@ -46657,18 +46773,18 @@ "type": "integer" }, { - "description": "parameters for network device", + "description": "", "length": 255, - "name": "networkdeviceparameterlist", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "", + "description": "parameters for network device", "length": 255, - "name": "page", + "name": "networkdeviceparameterlist", "required": false, - "type": "integer" + "type": "map" }, { "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", @@ -46680,22 +46796,22 @@ ], "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ID of the network device", "name": "id", "type": "string" }, - {}, {} ] }, @@ -46712,9 +46828,9 @@ "type": "string" }, { - "description": "the netmask for storage network", + "description": "the beginning IP address", "length": 255, - "name": "netmask", + "name": "startip", "required": false, "type": "string" }, @@ -46734,9 +46850,9 @@ "type": "uuid" }, { - "description": "the beginning IP address", + "description": "the netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" } @@ -46744,13 +46860,13 @@ "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "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 network uuid of storage network IP range", - "name": "networkid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { @@ -46759,49 +46875,124 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", + "params": [ + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the ID of the Pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedPods", + "response": [ + { + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, + {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, {}, { - "description": "the uuid of storage network IP range.", + "description": "the ID of the Pod", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", "name": "id", "type": "string" + }, + { + "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" } - ], - "since": "3.0.0" + ] }, { "description": "Lists Project roles in CloudStack", @@ -46809,19 +47000,18 @@ "name": "listProjectRoles", "params": [ { - "description": "List project role by project ID.", + "description": "List project role by project role name.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "List project role by project role ID.", @@ -46832,23 +47022,24 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "List project role by project ID.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "List project role by project role name.", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -46856,36 +47047,36 @@ "related": "createProjectRole,updateProjectRole", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, {}, + {}, { - "description": "the ID of the role", - "name": "id", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" @@ -46906,41 +47097,41 @@ ], "related": "addOpenDaylightController", "response": [ + {}, + {}, { "description": "device id of the controller", "name": "id", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", - "type": "string" - }, - { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, - {}, { "description": "the name assigned to the controller", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "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": "the url of the controller api", + "name": "url", "type": "string" } ] @@ -46951,44 +47142,37 @@ "name": "updateTemplate", "params": [ { - "description": "true if the image supports the password reset feature; default is false", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "cleanupdetails", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the name of the image file", + "description": "the type of the template", "length": 255, - "name": "name", + "name": "templatetype", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "sshkeyenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "isrouting", + "name": "requireshvm", "required": false, "type": "boolean" }, @@ -47007,33 +47191,18 @@ "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "the type of the template", - "length": 255, - "name": "templatetype", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the name of the image file", "length": 255, - "name": "requireshvm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "sort key of the template, integer", @@ -47051,114 +47220,50 @@ "type": "uuid" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - } - ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ - { - "description": "true if template is sshkey enabled, false otherwise", "name": "sshkeyenabled", + "required": false, "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, "name": "ostypeid", - "type": "string" + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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 template name", + "name": "name", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "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", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { @@ -47166,18 +47271,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -47186,128 +47291,183 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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 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 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": "the name of the domain to which the template belongs", - "name": "domain", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + {}, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the status of the template", + "name": "status", "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 template display text", - "name": "displaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, - {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, { "description": "the type of the template", "name": "templatetype", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "true if this template is a public template, false otherwise", @@ -47315,54 +47475,85 @@ "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "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 ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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" } ] }, @@ -47371,6 +47562,13 @@ "isasync": false, "name": "createVlanIpRange", "params": [ + { + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, { "description": "the network id", "length": 255, @@ -47380,46 +47578,45 @@ "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "ip6gateway", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "ip6cidr", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the physical network id", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "startipv6", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "vlan", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "netmask", + "name": "ip6gateway", "required": false, "type": "string" }, @@ -47430,6 +47627,20 @@ "required": false, "type": "string" }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "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, + "type": "string" + }, { "description": "the Zone ID of the VLAN IP range", "length": 255, @@ -47446,9 +47657,9 @@ "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "account", + "name": "startip", "required": false, "type": "string" }, @@ -47460,36 +47671,15 @@ "type": "boolean" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "startip", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" - }, - { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", + "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", @@ -47497,124 +47687,120 @@ "type": "uuid" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the physical network id", "length": 255, - "name": "startipv6", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ - { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" - }, { "description": "the cidr of the VLAN IP range", "name": "cidr", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the VLAN IP range", + "name": "id", "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 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 Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 description of the VLAN IP range", + "name": "description", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "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": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { @@ -47622,20 +47808,25 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the account of the VLAN IP range", "name": "account", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ] @@ -47673,29 +47864,20 @@ "related": "createVpnConnection,listVpnConnections", "response": [ { - "description": "the public IP address", - "name": "publicip", + "description": "the connection ID", + "name": "id", "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 domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { @@ -47703,35 +47885,55 @@ "name": "s2scustomergatewayid", "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": "State of vpn connection", - "name": "state", + "name": "passive", + "type": "boolean" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", "name": "ikeversion", "type": "string" }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, { "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", "name": "splitconnections", "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "IKE policy of the customer gateway", @@ -47739,74 +47941,63 @@ "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 public IP address", + "name": "publicip", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the project name", - "name": "project", + "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": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", "type": "string" }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - {}, { "description": "IPsec Preshared-Key of the customer gateway", "name": "ipsecpsk", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the owner", + "name": "account", "type": "string" } ], @@ -47817,6 +48008,13 @@ "isasync": false, "name": "listPaloAltoFirewallNetworks", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "palo alto balancer device ID", "length": 255, @@ -47825,53 +48023,72 @@ "required": true, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "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": "VPC the network belongs to", "name": "vpcid", "type": "string" }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the name of the Network associated with this 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": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "the type of the network", + "name": "type", + "type": "string" + }, + {}, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -47880,90 +48097,74 @@ "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { "description": "Broadcast domain type of the network", "name": "broadcastdomaintype", "type": "string" }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "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 network belongs to", "name": "zonename", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -47976,8 +48177,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -47985,11 +48186,6 @@ "name": "domainid", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -48011,37 +48207,52 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "the list of services", @@ -48052,14 +48263,14 @@ "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the destination physical network", @@ -48067,9 +48278,9 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "services for this provider", @@ -48082,27 +48293,17 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "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", @@ -48112,97 +48313,107 @@ "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { "description": "the ID of the Network associated with this private gateway", @@ -48210,28 +48421,23 @@ "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 internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -48240,18 +48446,18 @@ "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the id of the network", + "name": "id", "type": "string" }, { @@ -48260,8 +48466,13 @@ "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { @@ -48270,49 +48481,29 @@ "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "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": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, { "description": "zone id of the network", "name": "zoneid", "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ] }, @@ -48331,23 +48522,23 @@ ], "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": "The path field for the volume", "name": "path", "type": "string" - } + }, + {}, + {} ] }, { @@ -48356,49 +48547,74 @@ "name": "listManagementServers", "params": [ { - "description": "List by keyword", + "description": "the name of the management server", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the id of the management server", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the name of the management server", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "page", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, { "description": "the name of the OS distribution running on the management server", "name": "osdistribution", "type": "string" }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the ID of the management server", + "name": "id", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -48410,14 +48626,13 @@ "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 version of the java distribution running the management server process", - "name": "javaversion", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, {}, @@ -48427,40 +48642,16 @@ "type": "string" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" - }, - { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" - }, - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", + "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 state of the management server", "name": "state", "type": "state" }, - { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -48468,13 +48659,6 @@ "isasync": false, "name": "updateInstanceGroup", "params": [ - { - "description": "new instance group name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "Instance group ID", "length": 255, @@ -48482,14 +48666,21 @@ "related": "createInstanceGroup,updateInstanceGroup", "required": true, "type": "uuid" + }, + { + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "createInstanceGroup", "response": [ { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -48497,50 +48688,50 @@ "type": "boolean" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the 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 project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "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 ID of the instance group", + "name": "id", + "type": "string" }, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the name of the instance group", + "name": "name", "type": "string" }, + {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" } ] @@ -48551,26 +48742,19 @@ "name": "changeOfferingForVolume", "params": [ { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "automigrate", + "name": "miniops", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Verify OK to Shrink", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "shrinkok", + "name": "automigrate", "required": false, "type": "boolean" }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, { "description": "new disk offering id", "length": 255, @@ -48580,11 +48764,19 @@ "type": "uuid" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "maxiops", + "name": "shrinkok", "required": false, - "type": "long" + "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", @@ -48594,60 +48786,63 @@ "type": "long" }, { - "description": "the ID of the volume", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "maxiops", + "required": false, + "type": "long" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { @@ -48656,58 +48851,163 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "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": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -48720,8 +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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -48730,13 +49035,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -48745,13 +49050,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -48760,78 +49060,58 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the disk utilization", + "name": "utilization", "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": "ID of the disk offering", - "name": "diskofferingid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { "description": "name of the virtual machine", @@ -48839,29 +49119,19 @@ "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "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", @@ -48869,128 +49139,49 @@ "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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 name where the volume is allocated", - "name": "clustername", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the 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 ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, { "description": "the 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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ], @@ -49001,6 +49192,13 @@ "isasync": false, "name": "listTemplateDirectDownloadCertificates", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the zone where certificates are uploaded", "length": 255, @@ -49017,13 +49215,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -49034,7 +49225,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -49048,46 +49239,45 @@ ], "related": "uploadTemplateDirectDownloadCertificate", "response": [ - { - "description": "the direct download certificate issuer", - "name": "validity", - "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 zone id where the certificate is uploaded", "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, - {}, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { "description": "the direct download certificate issuer", @@ -49095,8 +49285,8 @@ "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { @@ -49104,17 +49294,18 @@ "name": "hypervisor", "type": "string" }, - { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" - }, + {}, + {}, { "description": "the direct download certificate alias", "name": "alias", "type": "string" }, - {} + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + } ], "since": "4.17.0" }, @@ -49123,13 +49314,6 @@ "isasync": false, "name": "listUcsManagers", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the ucs manager", "length": 255, @@ -49147,52 +49331,59 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addUcsManager", "response": [ { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of ucs manager", - "name": "name", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the url of ucs manager", "name": "url", "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", + "description": "the name of ucs manager", + "name": "name", "type": "string" } ] @@ -49222,53 +49413,39 @@ "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, + {}, { "description": "the version of the code / software in the router", "name": "softwareversion", "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 public MAC address for the router", - "name": "publicmacaddress", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, { "description": "the project name of the address", "name": "project", "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" }, { @@ -49277,115 +49454,205 @@ "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, - {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -49393,9 +49660,9 @@ "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 NSX Logical Switch Port (if NSX based), null otherwise", @@ -49403,39 +49670,29 @@ "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 ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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", @@ -49443,8 +49700,8 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -49452,134 +49709,77 @@ "name": "extradhcpoption", "type": "list" }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, { "description": "the netmask of the nic", "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "result of the health check", - "name": "success", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" } ], - "type": "list" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "type": "set" }, { - "description": "role of the domain router", - "name": "role", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { @@ -49588,68 +49788,69 @@ "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the gateway for the router", + "name": "gateway", "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 Pod name for the router", - "name": "podname", + "description": "role of the domain router", + "name": "role", "type": "string" } ] @@ -49660,11 +49861,11 @@ "name": "deleteLdapConfiguration", "params": [ { - "description": "port", + "description": "Hostname", "length": 255, - "name": "port", - "required": false, - "type": "integer" + "name": "hostname", + "required": true, + "type": "string" }, { "description": "linked domain", @@ -49675,41 +49876,41 @@ "type": "uuid" }, { - "description": "Hostname", + "description": "port", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "port", + "required": false, + "type": "integer" } ], "related": "addLdapConfiguration", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, - { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, + {}, { "description": "linked domain", "name": "domainid", "type": "string" }, + {}, { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.2.0" @@ -49720,34 +49921,36 @@ "name": "updateVolume", "params": [ { - "description": "The path of the volume", + "description": "the ID of the disk volume", "length": 255, - "name": "path", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "The chain info of the volume", "length": 255, - "name": "displayvolume", + "name": "chaininfo", "required": false, - "type": "boolean" + "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": "The state of the volume", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "state", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "since": "4.3", - "type": "string" + "type": "uuid" }, { "description": "new name of the volume", @@ -49757,14 +49960,6 @@ "since": "4.16", "type": "string" }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" - }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -49774,31 +49969,43 @@ "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "displayvolume", + "required": false, + "type": "boolean" + }, + { + "description": "The state of the volume", + "length": 255, + "name": "state", "required": false, "since": "4.3", - "type": "uuid" + "type": "string" } ], "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "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": "IO requests write rate of the disk volume per the disk offering", @@ -49806,82 +50013,137 @@ "type": "long" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the virtual machine", + "name": "vmname", "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": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, { "description": "true if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "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" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", "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 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" }, { @@ -49890,13 +50152,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": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -49904,6 +50166,16 @@ "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", @@ -49918,18 +50190,13 @@ "type": "set" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -49937,100 +50204,39 @@ "name": "diskiowrite", "type": "long" }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, { "description": "ID of the snapshot from which this volume was created", "name": "snapshotid", "type": "string" }, - {}, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { @@ -50039,25 +50245,24 @@ "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, - {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -50065,113 +50270,109 @@ "type": "integer" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "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": "pod name of the volume", - "name": "podname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, + {}, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" } ] @@ -50182,83 +50383,83 @@ "name": "listTrafficTypes", "params": [ { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "listNetworkServiceProviders", "response": [ + {}, { - "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": "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": "state of the network provider", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the provider name", "name": "name", "type": "string" }, - {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 current status of the latest 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 physical network this belongs to", + "name": "physicalnetworkid", "type": "string" + }, + {}, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "since": "3.0.0" @@ -50277,42 +50478,30 @@ "type": "uuid" }, { - "description": "The description of the Project role", + "description": "creates a project role with this unique name", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "creates a project role with this unique name", + "description": "The description of the Project role", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" } ], "related": "updateProjectRole", "response": [ - {}, - {}, - { - "description": "the ID of the role", - "name": "id", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -50321,115 +50510,433 @@ "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "type": "string" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ], "since": "4.15.0" }, { - "description": "Updates account information for the authenticated user", - "isasync": false, - "name": "updateAccount", + "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", "params": [ { - "description": "The UUID of the dynamic role to set for the account", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "Account UUID", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "New name for the account", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "newname", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Current account name", + "description": "type of the ICMP message being sent", "length": 255, - "name": "account", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Details for the account used to store specific parameters", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "accountdetails", + "name": "cidrlist", "required": false, - "type": "map" + "type": "list" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "networkdomain", + "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 UUID of the domain where the account exists", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "endport", "required": false, - "type": "uuid" + "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": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "response": [ + {}, { - "description": "the list of users associated with account", - "name": "user", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the 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 public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the 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": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 timezone user was created in", - "name": "timezone", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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" + } + ] + }, + { + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", + "params": [ + { + "description": "The UUID of the dynamic role to set for the account", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" + }, + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "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 list of users associated with account", + "name": "user", + "response": [ { "description": "the user name", "name": "username", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -50443,8 +50950,28 @@ "type": "date" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "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 account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -50453,13 +50980,18 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -50468,28 +51000,23 @@ "type": "resourceiconresponse" }, { - "description": "the user state", - "name": "state", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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 user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -50498,62 +51025,77 @@ "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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 state of the account", - "name": "state", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "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 number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { "description": "the total number of cpu cores available to be created for this account", @@ -50561,18 +51103,24 @@ "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "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" }, { @@ -50581,230 +51129,113 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "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": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "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 networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "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", - "type": "string" - }, - {}, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - {}, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "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 network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "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 networks available to be created for this account", - "name": "networkavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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", - "type": "boolean" - }, { "description": "the total number of projects the account can own", "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "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 default zone of the account", - "name": "defaultzoneid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" } ] @@ -50814,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, @@ -50821,87 +51259,80 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the name of the image store", + "name": "name", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "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 protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the 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 Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" } ] @@ -50912,27 +51343,25 @@ "name": "updateVirtualMachine", "params": [ { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "displayvm", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "displayvm", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the ID of the OS type that best represents this VM.", + "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", @@ -50943,11 +51372,11 @@ "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", "length": 255, - "name": "cleanupdetails", + "name": "details", "required": false, - "type": "boolean" + "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", @@ -50958,57 +51387,58 @@ "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "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": "name", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { - "description": "group of the virtual machine", + "description": "list of security group ids to be applied on the virtual machine.", "length": 255, - "name": "group", + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "user generated name", + "length": 255, + "name": "displayname", "required": false, "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "group of the virtual machine", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "group", "required": false, - "type": "map" + "type": "string" }, { - "description": "instance name of the user vm", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "instancename", + "name": "customid", "required": false, "since": "4.4", "type": "string" }, { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "isdynamicallyscalable", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "an optional 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": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "true if high-availability is enabled for the virtual machine, false otherwise", "length": 255, @@ -51017,370 +51447,228 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "the ID of the OS type that best represents this VM.", "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, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, "type": "uuid" }, { - "description": "user generated name", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", "length": 255, - "name": "displayname", + "name": "name", "required": false, + "since": "4.4", "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "The ID of the virtual machine", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "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 name of the host for the virtual machine", - "name": "hostname", + "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", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the state of the virtual machine", + "name": "state", "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "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": "macaddress", - "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the affinity group", + "name": "id", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the affinity group", + "name": "type", "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "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 ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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 ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -51393,8 +51681,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -51408,28 +51701,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -51440,144 +51728,120 @@ ], "type": "set" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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 group name of the virtual machine", - "name": "group", + "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "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": "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", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -51585,23 +51849,23 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -51610,66 +51874,56 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "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", "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "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", @@ -51677,47 +51931,37 @@ "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -51726,8 +51970,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -51735,6 +51984,11 @@ "name": "projectid", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", @@ -51744,79 +51998,84 @@ "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", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the 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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -51825,8 +52084,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -51835,59 +52094,69 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "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 domain ID of the security group", - "name": "domainid", + "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" }, { @@ -51898,25 +52167,30 @@ ], "type": "set" }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the 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", + "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 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.", @@ -51924,412 +52198,530 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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": "device ID of the root volume", - "name": "rootdeviceid", + "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": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the 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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "true if 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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" } ] }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "description": "Disables an account", "isasync": true, - "name": "createIpv6FirewallRule", + "name": "disableAccount", "params": [ { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "description": "If true, only lock the account; else disable the account", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "lock", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "Account id", "length": 255, - "name": "destcidrlist", + "name": "id", + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "Disables specified account.", "length": 255, - "name": "protocol", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "Disables specified account in this domain.", "length": 255, - "name": "traffictype", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, + "type": "uuid" + } + ], + "related": "createAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - } - ], - "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", - "response": [ + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the account", + "name": "name", "type": "string" }, - {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the id of the account", + "name": "id", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "list" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - } - ] - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "Disables specified account.", - "length": 255, - "name": "account", - "required": false, + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "Account id", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "Disables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", - "response": [ + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, { - "description": "the id of the account", - "name": "id", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ - { - "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 name", - "name": "username", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user email address", - "name": "email", - "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 account name of the user", + "name": "account", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "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 state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -52338,23 +52730,23 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", + "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 user ID", + "name": "id", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -52363,66 +52755,82 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "list" }, { - "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 number of networks available to be created for this account", - "name": "networkavailable", + "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": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { "description": "the total number of public ip addresses available for this account to acquire", "name": "ipavailable", "type": "string" }, + {}, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -52431,230 +52839,328 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the ID of the role", + "name": "roleid", + "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 public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "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": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists domains and provides detailed information for listed domains", + "isasync": false, + "name": "listDomains", + "params": [ + { + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "required": false, + "type": "integer" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "List domain by domain ID.", + "length": 255, + "name": "id", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "List domain by domain name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "If set to false, list only 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 number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "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 snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + {}, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, - {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of projects the account can own", + "description": "the total number of projects the domain can own", "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this domain", "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "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 cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { @@ -52663,468 +53169,547 @@ "type": "integer" }, { - "description": "the total memory (in MB) the account can own", + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of 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 memory (in MB) the domain can own", "name": "memorylimit", "type": "string" }, + {}, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" } ] }, { - "description": "Lists domains and provides detailed information for listed domains", - "isasync": false, - "name": "listDomains", + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", "params": [ { - "description": "List by keyword", + "description": "network domain", "length": 255, - "name": "keyword", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "List domain by domain ID.", + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "updateinsequence", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List domain by domain name.", + "description": "the new name for the network", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "listall", + "name": "displaynetwork", "required": false, "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "details", + "name": "changecidr", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "flag to display the resource icon for domains", + "description": "the ID of the network", "length": 255, - "name": "showicon", + "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": "", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "page", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "", + "description": "the new display text for the network", "length": 255, - "name": "pagesize", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List domains by domain level.", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "level", + "name": "guestvmcidr", "required": false, - "type": "integer" + "type": "string" + }, + { + "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": "listDomainChildren,listDomains", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, {}, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "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 projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "details for the domain", - "name": "domaindetails", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", "type": "map" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - } - ] - }, - { - "description": "Updates a network", - "isasync": true, - "name": "updateNetwork", - "params": [ - { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", - "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the new name for the network", - "length": 255, - "name": "name", - "required": false, + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, - "type": "boolean" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", - "length": 255, - "name": "hideipaddressusage", - "required": false, - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the new display text for the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of services", "name": "service", @@ -53138,15 +53723,15 @@ "name": "name", "type": "string" }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, { "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" @@ -53160,14 +53745,24 @@ "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": "state of the network provider", - "name": "state", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -53176,104 +53771,90 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { "description": "services for this provider", "name": "servicelist", "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" } ], "type": "list" } ], "type": "list" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, + } + ] + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", + "response": [ { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "description of usage type", + "name": "description", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "usage type", + "name": "usagetypeid", + "type": "integer" }, + {}, + {} + ] + }, + { + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteTemplate", + "params": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { - "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -53282,164 +53863,190 @@ "type": "integer" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ] + }, + { + "description": "Lists all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "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": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "list network ACLs by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "list network ACLs by specified name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", - "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "is ACL for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ID of the ACL", + "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 details of the network", - "name": "details", - "type": "map" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "Description of the ACL", + "name": "description", "type": "string" - }, + } + ] + }, + { + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", + "params": [ { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "archiveSnapshot,revertSnapshot", + "required": true, + "type": "uuid" + } + ], + "related": "revertSnapshot", + "response": [ { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -53448,88 +54055,57 @@ "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - {}, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the 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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -53538,107 +54114,134 @@ "type": "string" }, { - "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": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", - "response": [ + "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 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, {}, { - "description": "description of usage type", - "name": "description", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" } ] }, { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "description": "Deletes a VPC", "isasync": true, - "name": "deleteTemplate", + "name": "deleteVPC", "params": [ { - "description": "the ID of the template", + "description": "the ID of the VPC", "length": 255, "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" - }, - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - }, - { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -53653,136 +54256,137 @@ "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 all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list network ACLs by VPC ID", + "description": "id of customer gateway", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "account", + "name": "customid", "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "createVpnGateway,listVpnGateways", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, + {}, + {}, { - "description": "list network ACLs by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain id of the owner", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, + "description": "is vpn gateway for display to the regular user", "name": "fordisplay", - "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Lists network ACL with the specified ID.", + "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" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ + { + "description": "the ID of the dedicated guest vlan range", "length": 255, "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, + "related": "", + "required": true, "type": "uuid" } ], - "related": "createNetworkACLList", "response": [ {}, { - "description": "Description of the ACL", - "name": "description", - "type": "string" - }, - { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -53790,196 +54394,581 @@ "type": "string" }, { - "description": "the Name of the ACL", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ + { + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, "name": "name", + "required": false, "type": "string" }, - {}, { - "description": "the ID of the ACL", - "name": "id", + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "createSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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": "Archives (moves) a snapshot on primary storage to secondary storage", + "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", "isasync": true, - "name": "archiveSnapshot", + "name": "migrateVirtualMachine", "params": [ { - "description": "The ID of the snapshot", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "id", - "related": "archiveSnapshot,revertSnapshot", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "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, + "name": "autoselect", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "type": "uuid" + }, + { + "description": "the 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": "revertSnapshot", + "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": "display name of the os on volume", - "name": "osdisplayname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the project id of the snapshot", + "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, - {}, - {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "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 VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", + "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": "tag value", - "name": "value", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "device ID of the root volume", + "name": "rootdeviceid", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "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": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -53988,319 +54977,149 @@ "type": "integer" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", - "params": [ - { - "description": "the ID of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Updates site to site vpn local gateway", - "isasync": true, - "name": "updateVpnGateway", - "params": [ + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" - } - ], - "related": "createVpnGateway,listVpnGateways", - "response": [ + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the 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 vpc id of this gateway", - "name": "vpcid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the owner", - "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": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {} - ], - "since": "4.4" - }, - { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", - "params": [ - { - "description": "the ID of the dedicated guest vlan range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ] - }, - { - "description": "Deletes security group", - "isasync": false, - "name": "deleteSecurityGroup", - "params": [ - { - "description": "The ID of the security group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "createSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "the project of the security group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the account of the security group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", - "length": 255, - "name": "name", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {} - ] - }, - { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", - "isasync": true, - "name": "migrateVirtualMachine", - "params": [ - { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "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, - "name": "autoselect", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" - } - ], - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -54308,125 +55127,19 @@ "name": "keypairs", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, { "description": "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", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the 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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -54434,23 +55147,28 @@ "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", + "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -54459,13 +55177,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -54474,704 +55192,185 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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", + "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": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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": "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "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": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the 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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "list of 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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - { - "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, {}, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - {}, - { - "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -55179,40 +55378,67 @@ "name": "receivedbytes", "type": "long" }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { "description": "the user's ID who deployed the virtual machine", @@ -55220,33 +55446,28 @@ "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "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", + "description": "OS name of the vm", + "name": "osdisplayname", "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" } ] @@ -55266,8 +55487,6 @@ } ], "response": [ - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -55283,75 +55502,39 @@ "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "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" - } - ], - "related": "addBaremetalRct", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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" + "type": "uuid" }, { - "description": "id of rct", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", - "isasync": true, - "name": "createTemplate", - "params": [ - { - "description": "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" }, @@ -55363,19 +55546,12 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "isdynamicallyscalable", + "name": "ispublic", "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": "32 or 64 bit", "length": 255, @@ -55384,34 +55560,19 @@ "type": "integer" }, { - "description": "create template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the template", - "length": 255, - "name": "name", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "requireshvm", + "name": "passwordenabled", "required": false, "type": "boolean" }, - { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "type": "string" - }, { "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, @@ -55421,141 +55582,215 @@ "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ispublic", + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", "length": 255, - "name": "snapshotid", - "related": "revertSnapshot", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "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": "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": "true if the template requires HVM, false otherwise", "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": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "create template for the project", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "passwordenabled", + "name": "snapshotid", + "related": "revertSnapshot", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the name of the template", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" } ], "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "true if the 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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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" }, { - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "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", @@ -55563,90 +55798,94 @@ "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": "the account name to which the template belongs", - "name": "account", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "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 this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "the type of the template", @@ -55654,33 +55893,28 @@ "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the project name of the template", + "name": "project", "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -55689,95 +55923,144 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "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", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "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 ID of the zone for this template", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addBaremetalRct", + "response": [ {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "id of rct", + "name": "id", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the status of the template", - "name": "status", + "description": "url", + "name": "url", "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": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, + {}, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -55794,6 +56077,21 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "list dedicated clusters by affinity group", "length": 255, @@ -55816,21 +56114,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -55842,102 +56125,40 @@ "related": "", "response": [ { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "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 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": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, - "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" - }, - { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ {}, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { @@ -55962,28 +56183,28 @@ ], "related": "", "response": [ - {}, { "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" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the description of the CA service provider", + "name": "description", + "type": "string" + }, { "description": "the CA service provider name", "name": "name", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -56002,23 +56223,23 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, + { + "description": "the current status of the latest async job acting 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", @@ -56032,35 +56253,34 @@ "name": "listPortForwardingRules", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list port forwarding rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "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 resources by tags (key/value pairs)", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "tags", + "name": "id", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "required": false, - "type": "map" + "type": "uuid" }, { "description": "List by keyword", @@ -56070,55 +56290,56 @@ "type": "string" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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": "", + "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": "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,updateIpv6FirewallRule", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of IP address of the port forwarding services", "length": 255, - "name": "isrecursive", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -56130,32 +56351,16 @@ "type": "uuid" } ], - "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", "response": [ { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the 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", + "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", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -56164,18 +56369,8 @@ "type": "boolean" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { @@ -56183,18 +56378,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -56203,58 +56398,80 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + {}, + {}, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the protocol of the port forwarding rule", "name": "protocol", @@ -56266,20 +56483,24 @@ "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 starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM 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" } ] }, @@ -56308,20 +56529,19 @@ "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": "CIDR of the Pod", - "name": "cidr", + "description": "Gateway for Pod ", + "name": "gateway", "type": "string" }, {}, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "the ID of the nic", + "name": "nicid", "type": "long" }, { @@ -56330,29 +56550,30 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" }, + {}, { "description": "the ID of the pod the IP address", "name": "id", "type": "long" }, - { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" + { + "description": "CIDR of the Pod", + "name": "cidr", + "type": "string" }, { "description": "Allocated IP address", "name": "ipaddress", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -56373,13 +56594,8 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { @@ -56387,11 +56603,33 @@ "name": "hostid", "type": "string" }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + {}, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, { "description": "the out-of-band management driver for the host", "name": "driver", @@ -56402,41 +56640,24 @@ "name": "description", "type": "string" }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "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 username", - "name": "username", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -56447,6 +56668,21 @@ "isasync": false, "name": "updateTemplatePermissions", "params": [ + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, @@ -56455,11 +56691,11 @@ "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "op", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", @@ -56470,11 +56706,11 @@ "type": "list" }, { - "description": "true for featured template/iso, false otherwise", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "isfeatured", + "name": "op", "required": false, - "type": "boolean" + "type": "string" }, { "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", @@ -56482,46 +56718,31 @@ "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" - }, - { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -56536,14 +56757,6 @@ "required": false, "type": "string" }, - { - "description": "zone Id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -56557,441 +56770,107 @@ "name": "page", "required": false, "type": "integer" - } - ], - "related": "addTrafficMonitor", - "response": [ - { - "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 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 management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the external firewall", - "name": "id", - "type": "string" }, { - "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", + "description": "zone Id", "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", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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", + "related": "addTrafficMonitor", "response": [ { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the 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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the 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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "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": "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 name of the disk offering of the virtual machine", - "name": "diskofferingname", + "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 template for the virtual machine", - "name": "templatename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { "description": "the vGPU type used by the virtual machine", @@ -56999,32 +56878,22 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -57033,63 +56902,125 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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 list of resource tags associated with the rule", - "name": "tags", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" @@ -57100,143 +57031,86 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the list of 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": "the id of the security group rule", - "name": "ruleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -57248,14 +57122,19 @@ "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": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -57263,32 +57142,37 @@ "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": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -57297,13 +57181,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -57312,32 +57196,17 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" } ], "type": "set" @@ -57346,65 +57215,417 @@ "type": "set" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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 ID of the host for the virtual machine", - "name": "hostid", + "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the 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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the 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": "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" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", @@ -57420,14 +57641,19 @@ "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the nic", + "name": "id", "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the isolated private VLAN if available", @@ -57435,13 +57661,18 @@ "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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" }, { @@ -57455,13 +57686,8 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -57475,28 +57701,33 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the 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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -57505,66 +57736,66 @@ "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 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 type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "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 name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" } ] @@ -57575,37 +57806,45 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, - "name": "customid", + "name": "vmguestip", "required": false, - "since": "4.4", + "since": "4.5", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "fordisplay", + "name": "privateendport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the private end port of 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": "privateendport", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", "required": true, "since": "4.4", "type": "uuid" }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, @@ -57620,91 +57859,43 @@ "name": "privateport", "required": false, "type": "integer" - }, - { - "description": "VM guest nic Secondary ip address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", - "type": "string" } ], "related": "updateIpv6FirewallRule", "response": [ { "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "name": "vmguestip", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the VM ID for the port forwarding rule", "name": "virtualmachineid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, - {}, { "description": "the protocol of the port forwarding rule", "name": "protocol", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the 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" }, { @@ -57713,18 +57904,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -57733,13 +57919,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -57748,18 +57934,34 @@ "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", "type": "string" } ], "type": "list" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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 starting port of port forwarding rule's private port range", "name": "privateport", @@ -57771,15 +57973,44 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, - {}, { "description": "the public ip address for the port forwarding rule", "name": "ipaddress", "type": "string" + }, + { + "description": "the 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" } ] }, @@ -57788,13 +58019,6 @@ "isasync": false, "name": "listBrocadeVcsDevices", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "Brocade VCS switch ID", "length": 255, @@ -57806,65 +58030,72 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the principal switch Ip address", "name": "hostname", "type": "string" }, - {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "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": "device name", + "name": "brocadedevicename", + "type": "string" }, + {}, + {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -57872,13 +58103,6 @@ "isasync": false, "name": "linkDomainToLdap", "params": [ - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": false, - "type": "string" - }, { "description": "domain admin username in LDAP ", "length": 255, @@ -57908,6 +58132,13 @@ "required": false, "type": "string" }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "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, @@ -57918,30 +58149,31 @@ ], "related": "linkAccountToLdap", "response": [ + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, - {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "name", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { @@ -57950,14 +58182,13 @@ "type": "int" }, { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "type of the name in LDAP which is linke to the domain", + "name": "type", "type": "string" } ], @@ -57969,18 +58200,10 @@ "name": "associateIpAddress", "params": [ { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the domain to associate with this IP address", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -57993,19 +58216,19 @@ "type": "uuid" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the account to associate with this IP address", + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", "length": 255, - "name": "account", + "name": "isportable", "required": false, - "type": "string" + "type": "boolean" }, { "description": "region ID from where portable IP is to be associated.", @@ -58016,27 +58239,19 @@ "type": "integer" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", - "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" - }, - { - "description": "the VPC you want the IP address to be associated with", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "the account to associate with this IP address", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "IP Address to be associated", @@ -58044,36 +58259,41 @@ "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": "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": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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" }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, { "description": "the list of resource tags associated with ip address", "name": "tags", @@ -58083,6 +58303,11 @@ "name": "value", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -58094,13 +58319,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -58109,77 +58339,67 @@ "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", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "list" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "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": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "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", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { "description": "the name of the Network where ip belongs to", @@ -58187,44 +58407,49 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "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 zone the public IP address belongs to", - "name": "zonename", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -58233,23 +58458,29 @@ "type": "integer" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { @@ -58258,24 +58489,24 @@ "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "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 zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -58301,23 +58532,23 @@ ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "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" + } ] }, { @@ -58336,9 +58567,9 @@ ], "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", @@ -58346,16 +58577,16 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -58365,76 +58596,76 @@ "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,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "action", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ending port of ACL", "length": 255, - "name": "fordisplay", + "name": "endport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "type of the ICMP message being sent", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "icmptype", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "error code for this ICMP message", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "icmpcode", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "reason", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the ending port of ACL", + "description": "the starting port of ACL", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "cidrlist", + "name": "reason", "required": false, - "type": "list" + "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": "integer" + "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "error code for this ICMP message", "length": 255, - "name": "action", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { "description": "The number of the ACL item, its ordering", @@ -58444,49 +58675,28 @@ "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - {}, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, {}, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", @@ -58503,23 +58713,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project 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": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -58528,31 +58738,36 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -58560,50 +58775,66 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "Number of the ACL Item", + "name": "number", "type": "integer" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" } ] }, @@ -58613,18 +58844,26 @@ "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keypairs", "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, "type": "uuid" }, { @@ -58636,273 +58875,46 @@ "type": "uuid" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypair", "required": false, "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "keypairs", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.17", - "type": "list" + "type": "uuid" } ], "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN 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 ID of the corresponding network", - "name": "networkid", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -58911,40 +58923,9 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - {}, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of 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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the user's name who deployed the virtual machine", @@ -58954,65 +58935,40 @@ { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, + "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 name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the list of 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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "security group name", @@ -59024,13 +58980,13 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -59044,8 +59000,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -59054,23 +59010,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" } ], @@ -59082,49 +59038,109 @@ "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the 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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -59138,18 +59154,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -59158,204 +59174,434 @@ "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", + "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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 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 isolation uri of the nic", + "name": "isolationuri", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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": "the account owning the security group", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project 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 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": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, { "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", "name": "instancename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the 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": "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -59364,134 +59610,192 @@ "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the 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": "device ID of the root volume", - "name": "rootdeviceid", - "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", + "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 group name of the virtual machine", - "name": "group", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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 ID of the virtual machine", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", @@ -59499,118 +59803,55 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "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": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" } ] }, @@ -59620,34 +59861,34 @@ "name": "listVpnCustomerGateways", "params": [ { - "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": "id of the customer gateway", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "id of the customer gateway", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -59664,69 +59905,81 @@ "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createVpnCustomerGateway", "response": [ + {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, + {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the project name", - "name": "project", + "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": "the owner", + "name": "account", + "type": "string" }, { "description": "IPsec policy of customer gateway", @@ -59734,30 +59987,23 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project name", + "name": "project", "type": "string" }, - {}, { - "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": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { @@ -59766,18 +60012,13 @@ "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", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -59786,24 +60027,24 @@ "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" } ] }, @@ -59813,58 +60054,58 @@ "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "The vlan id the ip range sits on", + "description": "The ending IP address.", "length": 255, - "name": "vlan", + "name": "endip", "required": true, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The starting IP address.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "startip", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The starting 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 ending IP address.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "endip", + "name": "vlan", "required": true, "type": "string" } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.11.0.0" }, @@ -59882,9 +60123,9 @@ "type": "uuid" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "minmemory", + "name": "mincpunumber", "required": true, "type": "integer" }, @@ -59896,10 +60137,17 @@ "type": "string" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "url", - "required": false, + "name": "minmemory", + "required": true, + "type": "integer" + }, + { + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "length": 255, + "name": "semanticversion", + "required": true, "type": "string" }, { @@ -59910,37 +60158,19 @@ "type": "string" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "semanticversion", - "required": true, + "name": "url", + "required": false, "type": "string" - }, - { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "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 minimum number of CPUs needed for the Kubernetes supported version", @@ -59948,24 +60178,34 @@ "type": "integer" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, { "description": "Kubernetes semantic version", "name": "semanticversion", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { "description": "Name of the Kubernetes supported version", @@ -59977,30 +60217,36 @@ "name": "isoname", "type": "string" }, - {}, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the 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" } ] @@ -60020,22 +60266,22 @@ } ], "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": "any text associated with the success or failure", "name": "displaytext", @@ -60050,10 +60296,10 @@ "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "name of the load balancer rule", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -60064,11 +60310,12 @@ "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "domain name for the GSLB service.", @@ -60078,12 +60325,18 @@ "type": "string" }, { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "uuid" + "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.", @@ -60094,34 +60347,22 @@ "type": "integer" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "gslbservicetype", - "required": true, - "type": "string" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "account", - "required": false, + "name": "gslbservicetype", + "required": true, "type": "string" } ], "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, { "description": "global load balancer rule ID", "name": "id", @@ -60132,35 +60373,29 @@ "name": "gslbdomainname", "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": "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": "name of the global load balancer rule", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -60168,19 +60403,59 @@ "name": "gslblbmethod", "type": "string" }, - {}, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -60189,13 +60464,18 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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 public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { @@ -60204,18 +60484,18 @@ "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the load balancer rule ID", + "name": "id", "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 public port", + "name": "publicport", "type": "string" }, { @@ -60228,33 +60508,33 @@ "name": "tags", "response": [ { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -60263,84 +60543,54 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, { "description": "the load balancer algorithm (source, roundrobin, leastconn)", "name": "algorithm", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "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 id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -60349,15 +60599,11 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Region Id in which global load balancer is created", + "name": "regionid", "type": "integer" }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - } + {} ] }, { @@ -60375,17 +60621,10 @@ } ], "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", @@ -60393,9 +60632,16 @@ "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" } ] }, @@ -60405,18 +60651,19 @@ "name": "listGlobalLoadBalancerRules", "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 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": "", @@ -60426,97 +60673,100 @@ "type": "integer" }, { - "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": "region ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the global load balancer rule", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "region ID", "length": 255, - "name": "listall", + "name": "regionid", + "related": "addRegion,listRegions", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" }, - {}, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the account of the load balancer rule", + "name": "account", "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 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": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -60524,18 +60774,8 @@ "name": "loadbalancerrule", "response": [ { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -60543,38 +60783,13 @@ "name": "project", "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 domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -60583,8 +60798,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -60598,8 +60818,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -60608,36 +60828,41 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "list" }, { - "description": "the name of the load balancer", - "name": "name", + "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 id of the zone the rule belongs to", - "name": "zoneid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -60646,18 +60871,28 @@ "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -60666,8 +60901,23 @@ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the state of the rule", + "name": "state", + "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" }, { @@ -60676,97 +60926,54 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" } ], "type": "list" }, - { - "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": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, {}, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + {}, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, - {}, { - "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" } ] }, @@ -60785,23 +60992,23 @@ } ], "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -60814,13 +61021,6 @@ "isasync": false, "name": "listTags", "params": [ - { - "description": "list by value", - "length": 255, - "name": "value", - "required": false, - "type": "string" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -60837,108 +61037,111 @@ "type": "boolean" }, { - "description": "list by customer name", + "description": "list by resource type", "length": 255, - "name": "customer", + "name": "resourcetype", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "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 key", + "description": "", "length": 255, - "name": "key", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by resource type", + "description": "List by keyword", "length": 255, - "name": "resourcetype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list by resource id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourceid", + "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list by value", "length": 255, - "name": "keyword", + "name": "value", "required": false, "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list by key", + "length": 255, + "name": "key", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by customer name", "length": 255, - "name": "listall", + "name": "customer", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, {}, + {}, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -60947,34 +61150,77 @@ "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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": "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 ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, { "description": "Get Kubernetes cluster config", "isasync": false, @@ -60992,19 +61238,19 @@ "related": "", "response": [ { - "description": "the id of the container cluster", - "name": "id", + "description": "Name of the container cluster", + "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Name of the container cluster", - "name": "name", + "description": "the id of the container cluster", + "name": "id", "type": "string" }, {}, @@ -61044,41 +61290,31 @@ ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ - { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -61087,10 +61323,20 @@ "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -61103,6 +61349,22 @@ "isasync": true, "name": "createVPC", "params": [ + { + "description": "an optional field, whether to the display the vpc to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "create VPC for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, @@ -61111,18 +61373,18 @@ "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 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": "start", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", - "type": "boolean" + "type": "uuid" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "the display text of the VPC", "length": 255, - "name": "account", - "required": false, + "name": "displaytext", + "required": true, "type": "string" }, { @@ -61134,11 +61396,11 @@ "type": "uuid" }, { - "description": "create VPC for the project", + "description": "the ID of the availability zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { @@ -61149,35 +61411,19 @@ "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the vpc to the end user or not", + "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": "fordisplay", + "name": "start", "required": false, - "since": "4.4", + "since": "4.3", "type": "boolean" }, { - "description": "the display text of the VPC", - "length": 255, - "name": "displaytext", - "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.", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the name of the VPC", @@ -61190,33 +61436,23 @@ "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { @@ -61224,69 +61460,115 @@ "name": "jobid", "type": "string" }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, {}, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the cidr the VPC", + "name": "cidr", "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", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the id of the VPC", - "name": "id", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "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 list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -61295,8 +61577,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -61305,23 +61587,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -61333,19 +61615,14 @@ "type": "list" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the name of the VPC", @@ -61353,111 +61630,80 @@ "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], + "description": "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": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", "type": "list" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, {}, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "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" } ] }, @@ -61477,8 +61723,14 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -61488,16 +61740,10 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -61520,6 +61766,11 @@ "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", @@ -61531,11 +61782,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.9.0" @@ -61555,6 +61801,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", @@ -61565,17 +61822,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -61585,47 +61831,50 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "the state of the Internal LB VM", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "state", + "name": "fetchhealthcheckresults", "required": false, - "type": "string" + "since": "4.14", + "type": "boolean" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "the state of the Internal LB VM", "length": 255, - "name": "forvpc", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "listall", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the Internal LB VM", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "name", + "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": "string" + "type": "uuid" }, { "description": "the host ID of the Internal LB VM", @@ -61636,26 +61885,19 @@ "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", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -61673,73 +61915,102 @@ "type": "uuid" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "the Zone ID of the Internal LB VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List Internal LB VMs by VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "List by keyword", "length": 255, - "name": "fetchhealthcheckresults", + "name": "keyword", "required": false, - "since": "4.14", - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "keyword", + "name": "forvpc", "required": false, - "type": "string" + "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": "the name of the Internal LB VM", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "destroyRouter,listRouters", "response": [ { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -61748,18 +62019,18 @@ "type": "date" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -61768,9 +62039,9 @@ "type": "boolean" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { "description": "the ID of the service offering of the virtual machine", @@ -61778,38 +62049,38 @@ "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 network domain for the router", - "name": "networkdomain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { @@ -61818,83 +62089,157 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the template ID for the router", + "name": "templateid", + "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 any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "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": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -61902,63 +62247,33 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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" }, - { - "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 ip address of the nic", - "name": "ipaddress", - "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 ID of the nic", "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -61972,186 +62287,127 @@ "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": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "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 link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - {}, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - {}, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "result of the health check", - "name": "success", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "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": "list" + "type": "set" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the first DNS for the router", "name": "dns1", "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" } ] }, @@ -62168,20 +62424,19 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "Cisco VNMC resource ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": false, "type": "uuid" }, { - "description": "Cisco VNMC resource ID", + "description": "", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -62191,21 +62446,16 @@ "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, {}, @@ -62216,6 +62466,12 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -62232,31 +62488,32 @@ "type": "string" }, { - "description": "Delete details for resource id", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "resourceid", - "required": true, + "name": "key", + "required": false, "type": "string" }, { - "description": "Delete details matching key/value pairs", + "description": "Delete details for resource id", "length": 255, - "name": "key", - "required": false, + "name": "resourceid", + "required": true, "type": "string" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -62264,11 +62521,10 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -62284,12 +62540,11 @@ "type": "integer" }, { - "description": "list by Os type Id", + "description": "", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -62307,27 +62562,33 @@ "type": "uuid" }, { - "description": "list os by description", + "description": "list by Os type Id", "length": 255, - "name": "description", + "name": "id", + "related": "listOsTypes,addGuestOs", "required": false, - "since": "3.0.1", - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list os by description", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" } ], "related": "addGuestOs", "response": [ {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { @@ -62336,24 +62597,19 @@ "type": "integer" }, { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, - { - "description": "the name/description of the OS type", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" } ] @@ -62379,21 +62635,21 @@ "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -62413,28 +62669,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": "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.4.0" }, @@ -62466,27 +62722,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.16.0.0" @@ -62497,56 +62753,51 @@ "name": "listSrxFirewallNetworks", "params": [ { - "description": "", + "description": "netscaler load balancer device ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "lbdeviceid", + "related": "configureSrxFirewall", + "required": true, + "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": "netscaler load balancer device ID", + "description": "List by keyword", "length": 255, - "name": "lbdeviceid", - "related": "configureSrxFirewall", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { "description": "acl type - access type to the network", @@ -62554,151 +62805,276 @@ "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "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 the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "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": "related to what other network configuration", - "name": "related", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "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": "the owner of the network", - "name": "account", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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": "ACL name associated with the VPC network", - "name": "aclname", + "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "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 network domain", - "name": "networkdomain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { "description": "the project name of the address", @@ -62706,108 +63082,91 @@ "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "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 name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "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 guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -62816,13 +63175,13 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "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" }, { @@ -62837,43 +63196,103 @@ "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "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 displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, { "description": "true if network supports specifying ip ranges, false otherwise", "name": "specifyipranges", "type": "boolean" - }, + } + ] + }, + { + "description": "Update a supported Kubernetes version", + "isasync": false, + "name": "updateKubernetesSupportedVersion", + "params": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the enabled or disabled state of the Kubernetes supported version", + "length": 255, + "name": "state", + "required": true, "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" + } + ], + "related": "listKubernetesSupportedVersions", + "response": [ { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + {}, + { + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { @@ -62881,48 +63300,298 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" + }, + { + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "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": "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": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -62930,355 +63599,148 @@ "name": "resourcetype", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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", "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 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 the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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", - "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, - "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 id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "type": "set" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the id of the Kubernetes supported version", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" - }, - { - "description": "the enabled or disabled state of the Kubernetes supported version", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" - } - ] - }, - { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", - "isasync": true, - "name": "detachIso", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" }, { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "OS name of the vm", @@ -63286,353 +63748,225 @@ "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the group name of the virtual machine", "name": "group", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "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 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "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 name of the security group", - "name": "name", - "type": "string" - }, { "description": "the ID of the security group", "name": "id", "type": "string" }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the 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 code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -63640,28 +63974,28 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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 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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -63669,6 +64003,11 @@ "name": "domain", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -63680,21 +64019,21 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -63702,52 +64041,129 @@ "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, { "description": "the date when this virtual machine was updated last time", "name": "lastupdated", @@ -63759,200 +64175,110 @@ "type": "date" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "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 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 IPv6 address of network", - "name": "ip6address", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", - "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the 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", @@ -63960,18 +64286,18 @@ "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -63980,8 +64306,13 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -63993,18 +64324,13 @@ "type": "set" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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" }, { @@ -64013,63 +64339,8 @@ "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" } ] @@ -64079,13 +64350,6 @@ "isasync": true, "name": "createGuestNetworkIpv6Prefix", "params": [ - { - "description": "The /56 or higher IPv6 CIDR for network prefix.", - "length": 255, - "name": "prefix", - "required": true, - "type": "string" - }, { "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, @@ -64093,30 +64357,37 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "The /56 or higher IPv6 CIDR for network prefix.", + "length": 255, + "name": "prefix", + "required": true, + "type": "string" } ], "related": "listGuestNetworkIpv6Prefixes", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", "type": "integer" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { @@ -64125,24 +64396,24 @@ "type": "integer" }, { - "description": "id of the guest IPv6 prefix", - "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", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "type": "integer" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" } ], "since": "4.17.0.0" @@ -64163,26 +64434,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 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" + }, {} ] }, @@ -64201,28 +64472,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" - } + {} ] }, { @@ -64230,13 +64501,6 @@ "isasync": false, "name": "listDeploymentPlanners", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -64250,27 +64514,34 @@ "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" + } ] }, { @@ -64279,12 +64550,11 @@ "name": "createRole", "params": [ { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "The description of the role", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Creates a role with this unique name", @@ -64294,47 +64564,49 @@ "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "type", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The description of the role", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "description", + "name": "type", "required": false, "type": "string" } ], "related": "importRole,listRoles,updateRole", "response": [ - {}, { - "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" }, + {}, { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the type of the role", @@ -64345,8 +64617,7 @@ "description": "the name of the role", "name": "name", "type": "string" - }, - {} + } ], "since": "4.9.0" }, @@ -64365,18 +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", @@ -64386,6 +64652,11 @@ "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" } ] }, @@ -64406,26 +64677,10 @@ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the name of the host", + "name": "name", "type": "string" }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - {}, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -64440,24 +64695,24 @@ "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "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", @@ -64465,18 +64720,18 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" } ], @@ -64486,134 +64741,160 @@ "type": "list" }, { - "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 host version", - "name": "version", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "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": "the OS category name of the host", - "name": "oscategoryname", + "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 resource state of the host", + "name": "resourcestate", + "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 type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, - {}, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if 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 admin that annotated this host", - "name": "username", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, + {}, + {}, { - "description": "true if 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 last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", + "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 host version", + "name": "version", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { @@ -64622,59 +64903,59 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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 created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category name of the host", + "name": "oscategoryname", "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 CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { "description": "the amount of the host's memory currently used", @@ -64682,89 +64963,79 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the cluster name of the host", - "name": "clustername", + "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 number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" } ] }, @@ -64787,22 +65058,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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, @@ -64822,22 +65093,22 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "type": "string" }, {}, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -64853,27 +65124,26 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "the name of the volume/template", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "format", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", @@ -64883,13 +65153,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the volume/template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "Upload volume/template for the project", "length": 255, @@ -64899,44 +65162,57 @@ "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.", + "description": "Image store uuid", "length": 255, - "name": "checksum", + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "Image store uuid", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "imagestoreuuid", - "required": false, + "name": "format", + "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" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, - {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, { "description": "POST url to upload the file to", "name": "postURL", @@ -64946,11 +65222,6 @@ "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" } ], "since": "4.6.0" @@ -64960,6 +65231,22 @@ "isasync": true, "name": "updateAutoScaleVmGroup", "params": [ + { + "description": "an optional field, whether to the display the group to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" + }, { "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", "length": 255, @@ -64968,9 +65255,17 @@ "type": "integer" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "the ID of the autoscale group", "length": 255, - "name": "maxmembers", + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "length": 255, + "name": "interval", "required": false, "type": "integer" }, @@ -64983,20 +65278,12 @@ "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", + "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": "interval", + "name": "maxmembers", "required": false, "type": "integer" }, - { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, { "description": "list of scaleup autoscale policies", "length": 255, @@ -65004,71 +65291,36 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" - }, - { - "description": "an optional field, whether to the display the group to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the autoscale vm group ID", "name": "id", "type": "string" }, + {}, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "the load balancer rule ID", "name": "lbruleid", "type": "string" }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the project name of the vm profile", "name": "project", @@ -65079,18 +65331,32 @@ "name": "domain", "type": "string" }, - {}, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, { "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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", @@ -65102,9 +65368,14 @@ "type": "int" }, { - "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": "the project id vm profile", + "name": "projectid", + "type": "string" }, { "description": "the frequency at which the conditions have to be evaluated", @@ -65119,20 +65390,20 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "customid", + "name": "autoscaleuserid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { "description": "an optional field, whether to the display the profile to the end user or not", @@ -65149,6 +65420,14 @@ "required": false, "type": "map" }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, @@ -65163,85 +65442,76 @@ "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, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" } ], "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "response": [ - { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" - }, { "description": "the availability zone to be used while deploying a virtual machine", "name": "zoneid", "type": "string" }, - {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", "type": "string" }, + {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, - {}, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { @@ -65249,10 +65519,11 @@ "name": "autoscaleuserid", "type": "string" }, + {}, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" } ] }, @@ -65273,14 +65544,9 @@ "related": "listAutoScaleVmGroups", "response": [ { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "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", @@ -65288,13 +65554,23 @@ "type": "integer" }, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { @@ -65303,8 +65579,13 @@ "type": "list" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { @@ -65313,51 +65594,41 @@ "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 minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, - {}, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, { "description": "the project id vm profile", "name": "projectid", "type": "string" }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, {}, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "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 scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the domain name of the vm profile", "name": "domain", "type": "string" + }, + { + "description": "the project name of the vm profile", + "name": "project", + "type": "string" } ] }, @@ -65377,34 +65648,41 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ] }, { - "description": "List the virtual machines owned by the account.", + "description": "Lists guest network IPv6 prefixes", "isasync": false, - "name": "listVirtualMachines", + "name": "listGuestNetworkIpv6Prefixes", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -65413,51 +65691,145 @@ "type": "integer" }, { - "description": "list by network id", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "UUID of the IPv6 prefix.", + "length": 255, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "displayvm", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the security 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": "securitygroupid", - "related": "createSecurityGroup", + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "length": 255, + "name": "haenable", "required": false, "since": "4.15", + "type": "boolean" + }, + { + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, "type": "uuid" }, { - "description": "list vms by iso", + "description": "the availability zone ID", "length": 255, - "name": "isoid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "list by the backup offering", + "description": "list vms by iso", "length": 255, - "name": "backupofferingid", + "name": "isoid", "required": false, - "since": "4.17", "type": "uuid" }, { @@ -65470,63 +65842,72 @@ "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the target hypervisor for the template", "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "hypervisor", "required": false, - "since": "4.4", - "type": "list" + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "listall", + "name": "keypair", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "description": "the security group ID", "length": 255, - "name": "showicon", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "list vms by 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": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forvirtualnetwork", + "name": "displayvm", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, @@ -65538,74 +65919,105 @@ "type": "string" }, { - "description": "list vms by ssh keypair name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keypair", + "name": "listall", "required": false, - "type": "string" + "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": "list vms by affinity group", "length": 255, - "name": "state", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "pagesize", + "name": "accumulate", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the group ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "groupid", - "related": "createInstanceGroup", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "showicon", + "required": false, + "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": "the user ID that created the VM and is under the account that owns the VM", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "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": "the availability zone ID", + "description": "list vms by vpc", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "haenable", + "name": "forvirtualnetwork", "required": false, - "since": "4.15", "type": "boolean" }, + { + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, { "description": "the pod ID", "length": 255, @@ -65615,169 +66027,271 @@ "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "the host ID", "length": 255, - "name": "accumulate", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list vms by template", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "list vms by vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "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 group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", - "length": 255, - "name": "details", - "required": false, - "type": "list" - } - ], - "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 host for the virtual machine", - "name": "hostid", + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -65786,43 +66300,38 @@ "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -65831,28 +66340,18 @@ "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -65861,136 +66360,74 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "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 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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", @@ -66001,28 +66438,23 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "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 domain ID of the affinity group", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -66031,13 +66463,18 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { @@ -66049,185 +66486,93 @@ "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 name of the domain in which the virtual machine exists", - "name": "domain", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "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 id of the security group rule", - "name": "ruleid", - "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", + "response": [ + { + "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", @@ -66238,28 +66583,23 @@ "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": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -66273,48 +66613,56 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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 account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "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" }, { @@ -66323,72 +66671,131 @@ "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" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "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": "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": "tag value", - "name": "value", + "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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 account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -66397,8 +66804,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], @@ -66408,138 +66815,111 @@ "description": "the id of the security group rule", "name": "ruleid", "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the protocol of the security group rule", + "name": "protocol", "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 ID of the security group", - "name": "id", + "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 description of the security group", "name": "description", "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "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": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the 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 group name of the virtual machine", - "name": "group", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { @@ -66548,53 +66928,8 @@ "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -66603,136 +66938,82 @@ "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" - } - ] - }, - { - "description": "Lists guest network IPv6 prefixes", - "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", - "params": [ - { - "description": "UUID of the IPv6 prefix.", - "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "guest IPv6 prefix", - "name": "prefix", + "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": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" - }, - {} - ], - "since": "4.17.0" + } + ] }, { "description": "Updates the information about Guest OS to Hypervisor specific name mapping", @@ -66740,28 +67021,24 @@ "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": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66773,29 +67050,29 @@ "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "is the mapping user defined", + "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": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "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" }, { @@ -66803,7 +67080,11 @@ "name": "id", "type": "string" }, - {} + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + } ], "since": "4.4.0" }, @@ -66813,21 +67094,11 @@ "name": "listDiskOfferings", "params": [ { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -66836,20 +67107,6 @@ "required": false, "type": "boolean" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "ID of the disk offering", "length": 255, @@ -66858,10 +67115,17 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -66884,71 +67148,83 @@ "type": "uuid" }, { - "description": "name of the disk offering", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.17", + "type": "uuid" } ], "related": "createDiskOffering", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" - }, - { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { "description": "bytes read rate of the disk offering", @@ -66956,25 +67232,24 @@ "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { "description": "burst bytes write rate of the disk offering", @@ -66982,34 +67257,39 @@ "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "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": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -67017,38 +67297,39 @@ "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, + {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { @@ -67057,31 +67338,31 @@ "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + } ] }, { @@ -67112,22 +67393,28 @@ "required": false, "type": "uuid" }, - { - "description": "if the password should also be updated on the hosts", - "length": 255, - "name": "update_passwd_on_host", - "required": false, - "type": "boolean" - }, { "description": "the new password for the host/cluster", "length": 255, "name": "password", "required": true, "type": "string" + }, + { + "description": "if the password should also be updated on the hosts", + "length": 255, + "name": "update_passwd_on_host", + "required": false, + "type": "boolean" } ], "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", @@ -67143,13 +67430,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -67158,18 +67439,19 @@ "name": "createPortableIpRange", "params": [ { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "the gateway for the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the gateway for the portable IP range", + "description": "Id of the Region", "length": 255, - "name": "gateway", + "name": "regionid", + "related": "addRegion,listRegions", "required": true, - "type": "string" + "type": "integer" }, { "description": "the beginning IP address in the portable IP range", @@ -67179,63 +67461,104 @@ "type": "string" }, { - "description": "the netmask of the portable IP range", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, - "name": "netmask", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "Id of the Region", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "endip", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "the netmask of the portable IP range", "length": 255, - "name": "endip", + "name": "netmask", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "the start ip of the portable IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + { + "description": "the 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": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { "description": "the physical network this belongs to", @@ -67243,69 +67566,27 @@ "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "public IP address", + "name": "ipaddress", "type": "string" } ], "type": "list" }, - { - "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 start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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 end ip of the portable IP range", "name": "endip", "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" } ], "since": "4.2.0" @@ -67316,9 +67597,9 @@ "name": "updateCluster", "params": [ { - "description": "hypervisor type of the cluster", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "clustertype", + "name": "managedstate", "required": false, "type": "string" }, @@ -67330,23 +67611,16 @@ "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "hypervisor type of the cluster", "length": 255, - "name": "managedstate", + "name": "clustertype", "required": false, "type": "string" }, { "description": "the cluster name", "length": 255, - "name": "clustername", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", + "name": "clustername", "required": false, "type": "string" }, @@ -67357,28 +67631,20 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" } ], "related": "addCluster", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "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" }, { @@ -67386,20 +67652,9 @@ "name": "zoneid", "type": "string" }, - {}, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { @@ -67408,52 +67663,52 @@ "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "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" }, { @@ -67462,27 +67717,53 @@ "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], "type": "list" }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { @@ -67491,18 +67772,18 @@ "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the cluster name", + "name": "name", "type": "string" }, { @@ -67511,8 +67792,8 @@ "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" } ] @@ -67532,11 +67813,10 @@ } ], "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" }, {}, { @@ -67544,15 +67824,16 @@ "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" } ] }, @@ -67562,18 +67843,18 @@ "name": "upgradeKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": true, "type": "uuid" }, { - "description": "the ID of the Kubernetes version for upgrade", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" } @@ -67581,53 +67862,53 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "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": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "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 project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "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" }, { @@ -67636,38 +67917,34 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { @@ -67675,45 +67952,40 @@ "name": "description", "type": "string" }, - {}, - { - "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", + "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": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + {}, { "description": "Minimum size of the cluster", "name": "minsize", "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "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" }, { @@ -67721,20 +67993,19 @@ "name": "keypair", "type": "string" }, + { + "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", "type": "long" }, - {}, - { - "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 account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { @@ -67743,35 +68014,42 @@ "type": "boolean" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" } ] }, { - "description": "List profile in ucs manager", + "description": "Lists storage providers.", "isasync": false, - "name": "listUcsProfiles", + "name": "listStorageProviders", "params": [ - { - "description": "the id for the ucs manager", - "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -67786,6 +68064,13 @@ "required": false, "type": "integer" }, + { + "description": "the type of storage provider: either primary or image", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, { "description": "", "length": 255, @@ -67802,8 +68087,13 @@ "type": "integer" }, { - "description": "ucs profile dn", - "name": "ucsdn", + "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" }, {}, @@ -67816,16 +68106,17 @@ ] }, { - "description": "Lists storage providers.", + "description": "List profile in ucs manager", "isasync": false, - "name": "listStorageProviders", + "name": "listUcsProfiles", "params": [ { - "description": "the type of storage provider: either primary or image", + "description": "the id for the ucs manager", "length": 255, - "name": "type", + "name": "ucsmanagerid", + "related": "addUcsManager", "required": true, - "type": "string" + "type": "uuid" }, { "description": "", @@ -67835,36 +68126,26 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "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 name of the storage provider", - "name": "name", - "type": "string" - }, - { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "ucs profile dn", + "name": "ucsdn", "type": "string" }, { @@ -67872,6 +68153,11 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -67891,10 +68177,9 @@ ], "related": "registerUserKeys", "response": [ - {}, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -67902,16 +68187,17 @@ "name": "apikey", "type": "string" }, + {}, + {}, + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.10.0" @@ -67921,13 +68207,6 @@ "isasync": true, "name": "updateGlobalLoadBalancerRule", "params": [ - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, { "description": "the ID of the global load balancer rule", "length": 255, @@ -67949,30 +68228,45 @@ "name": "gslblbmethod", "required": false, "type": "string" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, { "description": "the project name of the load balancer", "name": "project", "type": "string" }, - {}, { - "description": "global load balancer rule ID", - "name": "id", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -67980,64 +68274,60 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + {}, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, { "description": "name of the global load balancer rule", "name": "name", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", @@ -68054,18 +68344,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -68074,51 +68364,56 @@ "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", + "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 name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -68131,69 +68426,60 @@ "name": "description", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the project id of the load balancer", "name": "projectid", "type": "string" }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, { "description": "the id of the guest network the lb rule belongs to", "name": "networkid", "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" } ], "type": "list" }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" - } + }, + {} ] }, { @@ -68201,14 +68487,6 @@ "isasync": true, "name": "createCondition", "params": [ - { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - }, { "description": "Threshold value.", "length": 255, @@ -68216,14 +68494,6 @@ "required": true, "type": "long" }, - { - "description": "the domain ID of the account.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, { "description": "Relational Operator to be used with threshold.", "length": 255, @@ -68237,10 +68507,36 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "ID of the Counter.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" + }, + { + "description": "the domain ID of the account.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of the Condition", + "name": "id", + "type": "string" + }, { "description": "the project id of the Condition.", "name": "projectid", @@ -68252,56 +68548,46 @@ "type": "string" }, { - "description": "the id of the Condition", - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, { "description": "the project name of the Condition", "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" }, - {}, { "description": "the domain id of the Condition owner", "name": "domainid", "type": "string" }, - { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" - }, {}, { "description": "Details of the Counter.", "name": "counter", "type": "list" - }, - { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, - { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" } ] }, @@ -68311,25 +68597,26 @@ "name": "listProjects", "params": [ { - "description": "flag to display the resource icon for projects", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List projects by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "listall", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { "description": "", @@ -68339,40 +68626,40 @@ "type": "integer" }, { - "description": "list projects by project ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "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 state", + "description": "list projects by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list projects by project ID", "length": 255, - "name": "account", + "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list projects by state", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { "description": "List projects by username", @@ -68382,33 +68669,32 @@ "type": "string" }, { - "description": "list projects by name", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "name", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { "description": "list projects by display text", @@ -68420,44 +68706,210 @@ ], "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "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 cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "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 list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -68466,87 +68918,72 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "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 displaytext of the project", - "name": "displaytext", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the id of the project", + "name": "id", "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 stored by this project", "name": "snapshottotal", "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { "description": "the account name of the project's owners", @@ -68554,397 +68991,519 @@ "type": "list" }, { - "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 total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "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 id of the project", - "name": "id", - "type": "string" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "the name of the project", - "name": "name", + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "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 number of templates available to be created by this project", - "name": "templateavailable", + "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 vpcs the project can own", - "name": "vpclimit", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "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 state of the project", - "name": "state", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "email", + "length": 255, + "name": "email", + "required": true, + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "the domain id the project belongs to", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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) owned by project", - "name": "memorytotal", + "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 secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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 project", + "description": "the total number of snapshots available for this account", "name": "snapshotavailable", "type": "string" }, { - "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 account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of networks the project can own", + "description": "the total number of networks the account can own", "name": "networklimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ + }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "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 total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the state of the account", + "name": "state", "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": "the total number of templates which can be created by this account", - "name": "templatelimit", + "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": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the 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 number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "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": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "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 virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the 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 name of the account", - "name": "name", - "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 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", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "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", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { "description": "true if the account requires cleanup", @@ -68952,372 +69511,568 @@ "type": "boolean" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "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 total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" - }, + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ { - "description": "the default zone of the account", - "name": "defaultzoneid", - "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 id of the account", - "name": "id", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "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", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "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", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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 api key of the user", - "name": "apikey", + "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": "list" + "type": "set" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "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 total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "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 total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" - } - ] - }, - { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the 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 disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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 starting IP of the security group rule", - "name": "startport", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -69325,23 +70080,23 @@ "name": "tags", "response": [ { - "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -69350,13 +70105,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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -69365,8 +70120,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -69378,36 +70133,51 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -69421,103 +70191,76 @@ "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "tag 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "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", + "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 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" }, { @@ -69525,6 +70268,11 @@ "name": "domainid", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -69536,202 +70284,69 @@ "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": "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 protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the 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" } ], "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" } ], "type": "set" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "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 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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -69740,478 +70355,159 @@ "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the 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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, { "description": "the amount of the vm's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the 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 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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the virtual machine", + "name": "id", "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "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", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "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": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "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 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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "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": "publicipid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { "description": "the write (IO) of disk on the VM", "name": "diskiowrite", "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" } ], "since": "4.2.0" @@ -70222,23 +70518,23 @@ "name": "listHostTags", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -70250,28 +70546,28 @@ "name": "id", "type": "string" }, - { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the name of the host tag", "name": "name", "type": "string" }, + {}, + { + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -70280,12 +70576,11 @@ "name": "addGuestOs", "params": [ { - "description": "ID of Guest OS category", + "description": "Map of (key/value pairs)", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "details", "required": true, - "type": "uuid" + "type": "map" }, { "description": "Optional name for Guest OS", @@ -70302,11 +70597,12 @@ "type": "string" }, { - "description": "Map of (key/value pairs)", + "description": "ID of Guest OS category", "length": 255, - "name": "details", + "name": "oscategoryid", + "related": "listOsCategories", "required": true, - "type": "map" + "type": "uuid" } ], "related": "", @@ -70316,21 +70612,22 @@ "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" }, { "description": "the name/description of the OS type", "name": "description", "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", @@ -70341,8 +70638,7 @@ "description": "the ID of the OS type", "name": "id", "type": "string" - }, - {} + } ], "since": "4.4.0" }, @@ -70351,13 +70647,6 @@ "isasync": false, "name": "addAnnotation", "params": [ - { - "description": "the id of the entity to annotate", - "length": 255, - "name": "entityid", - "required": false, - "type": "string" - }, { "description": "the annotation is visible for admins only", "length": 255, @@ -70373,6 +70662,13 @@ "required": false, "type": "string" }, + { + "description": "the id of the entity to annotate", + "length": 255, + "name": "entityid", + "required": false, + "type": "string" + }, { "description": "the entity type (only HOST is allowed atm)", "length": 255, @@ -70383,25 +70679,19 @@ ], "related": "removeAnnotation,updateAnnotationVisibility", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the (uu)id of the entitiy to which this annotation pertains", "name": "entityid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { @@ -70409,16 +70699,6 @@ "name": "created", "type": "date" }, - { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" - }, { "description": "True if the annotation is available for admins only", "name": "adminsonly", @@ -70430,20 +70710,36 @@ "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 name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "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" @@ -70463,23 +70759,23 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -70493,13 +70789,6 @@ "isasync": false, "name": "registerIso", "params": [ - { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "the name of the ISO", "length": 255, @@ -70508,26 +70797,34 @@ "type": "string" }, { - "description": "true if you want this ISO to be featured", + "description": "Image store UUID", "length": 255, - "name": "isfeatured", + "name": "imagestoreuuid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if password reset feature is supported; default is false", + "description": "Register ISO for the project", "length": 255, - "name": "passwordenabled", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, + "description": "an optional account name. Must be used with domainId.", + "length": 255, + "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" + }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, @@ -70537,82 +70834,81 @@ "type": "uuid" }, { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isdynamicallyscalable", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "isextractable", + "name": "isdynamicallyscalable", "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": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "ostypeid", - "related": "", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "account", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "the ID of the zone you wish to register the ISO to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Image store UUID", + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "imagestoreuuid", + "name": "checksum", "required": false, "type": "string" }, { - "description": "Register ISO for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "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": "checksum", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "directdownload", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" } @@ -70620,29 +70916,29 @@ "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the status of the template", + "name": "status", + "type": "string" }, { "description": "the size of the template", @@ -70651,9 +70947,19 @@ }, {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { "description": "the physical size of the template", @@ -70661,33 +70967,43 @@ "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "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 ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -70696,42 +71012,77 @@ "type": "imageformat" }, { - "description": "the template ID", - "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": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the 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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the zone 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", "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -70740,23 +71091,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -70765,91 +71116,47 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the template", - "name": "project", + "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", - "type": "boolean" - }, { "description": "true if the reset password feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -70857,71 +71164,60 @@ "name": "projectid", "type": "string" }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, { "description": "true if this template is a featured template, false otherwise", "name": "isfeatured", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID", + "name": "id", "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 type of the template", - "name": "templatetype", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" } ] }, @@ -70931,19 +71227,26 @@ "name": "listCiscoAsa1000vResources", "params": [ { - "description": "Cisco ASA 1000v resource ID", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "page", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -70960,13 +71263,6 @@ "required": false, "type": "uuid" }, - { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -70977,15 +71273,6 @@ ], "related": "addCiscoAsa1000vResource", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - {}, - {}, {}, {}, { @@ -70993,6 +71280,15 @@ "name": "jobid", "type": "string" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, {} ] }, @@ -71002,18 +71298,18 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "availability zone for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, @@ -71041,35 +71337,30 @@ "name": "lbdevicename", "type": "string" }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the public interface of the load balancer", "name": "publicinterface", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { "description": "device id of the netscaler load balancer", @@ -71077,40 +71368,49 @@ "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "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": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "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" }, { @@ -71118,11 +71418,7 @@ "name": "privateinterface", "type": "string" }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - } + {} ] }, { @@ -71140,15 +71436,14 @@ ], "related": "", "response": [ - {}, { - "description": "the id of the volume", - "name": "id", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "syncronization", - "name": "sync", + "description": "compression", + "name": "compression", "type": "string" }, { @@ -71156,30 +71451,70 @@ "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": "compression", - "name": "compression", + "description": "syncronization", + "name": "sync", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the name of the volume", - "name": "name", + "description": "graceallowed", + "name": "graceallowed", + "type": "string" + } + ] + }, + { + "description": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", + "params": [ + { + "description": "Id of the portable ip range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "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": "graceallowed", - "name": "graceallowed", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -71196,6 +71531,13 @@ "required": true, "type": "string" }, + { + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "Pod Id", "length": 255, @@ -71214,7 +71556,7 @@ { "description": "Credentials to reach external pxe device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -71232,41 +71574,24 @@ "related": "createPhysicalNetwork", "required": true, "type": "uuid" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, - "type": "string" } ], "related": "", "response": [ {}, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -71274,51 +71599,22 @@ "name": "tftpdir", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url", + "name": "url", "type": "string" }, - {} - ] - }, - { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", - "params": [ - { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { "description": "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" - }, - {} + } ] }, { @@ -71336,7 +71632,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -71359,33 +71655,19 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "addNiciraNvpDevice", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device name", - "name": "niciradevicename", - "type": "string" - }, - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" - }, { "description": "the transport zone Uuid", "name": "transportzoneuuid", "type": "string" }, + {}, { "description": "this L3 gateway service Uuid", "name": "l3gatewayserviceuuid", @@ -71397,14 +71679,23 @@ "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device name", + "name": "niciradevicename", + "type": "string" + }, + { + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -71412,12 +71703,17 @@ "name": "nvpdeviceid", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "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" + } ] }, { @@ -71426,26 +71722,25 @@ "name": "listAlerts", "params": [ { - "description": "List by keyword", + "description": "list by alert type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "list by alert name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the alert", @@ -71463,10 +71758,11 @@ "type": "integer" }, { - "description": "list by alert type", + "description": "list by alert name", "length": 255, - "name": "type", + "name": "name", "required": false, + "since": "4.3", "type": "string" } ], @@ -71477,11 +71773,9 @@ "name": "sent", "type": "date" }, - {}, - {}, { - "description": "the id of the alert", - "name": "id", + "description": "description of the alert", + "name": "description", "type": "string" }, { @@ -71490,24 +71784,26 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "description of the alert", - "name": "description", - "type": "string" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" + "description": "the id of the alert", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -71516,6 +71812,22 @@ "isasync": true, "name": "deployVirtualMachine", "params": [ + { + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" + }, { "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, @@ -71526,62 +71838,50 @@ "type": "uuid" }, { - "description": "an optional group for the virtual machine", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "group", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "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": "overridediskofferingid", - "related": "createDiskOffering", + "name": "iptonetworklist", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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": "details", + "name": "affinitygroupnames", + "related": "", "required": false, - "since": "4.3", - "type": "map" + "type": "list" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "displayname", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keypairs", "required": false, - "type": "uuid" + "since": "4.17", + "type": "list" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "used to specify the vApp properties.", "length": 255, - "name": "nicnetworklist", + "name": "properties", "required": false, "since": "4.15", "type": "map" }, - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, { "description": "the mac address for default vm's network", "length": 255, @@ -71590,49 +71890,59 @@ "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "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": "keypairs", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "since": "4.17", "type": "list" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "diskofferingid", + "related": "createDiskOffering", + "required": false, + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, "type": "string" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", + "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": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.13", - "type": "boolean" + "type": "list" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "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": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "datadiskofferinglist", "required": false, - "type": "uuid" + "since": "4.11", + "type": "map" }, { - "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": "Deploy vm for the project", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" }, { "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", @@ -71643,90 +71953,64 @@ "type": "boolean" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "the ip address for default vm's network", "length": 255, - "name": "boottype", + "name": "ipaddress", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "used to specify the vApp properties.", + "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": "properties", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.15", "type": "map" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", - "length": 255, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "host name for the virtual machine", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "datadiskofferinglist", + "name": "startvm", "required": false, - "since": "4.11", - "type": "map" + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "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": "dynamicscalingenabled", + "name": "rootdisksize", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.4", + "type": "long" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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": "displayvm", + "name": "nicnetworklist", "required": false, - "since": "4.2", - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "availability zone for the virtual machine", "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "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": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "copyimagetags", "required": false, - "type": "list" + "since": "4.13", + "type": "boolean" }, { "description": "name of the ssh key pair used to login to the virtual machine", @@ -71736,86 +72020,81 @@ "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "host name for the virtual machine", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", "required": false, - "since": "4.12", "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "an optional group for the virtual machine", "length": 255, - "name": "iptonetworklist", + "name": "group", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "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": "securitygroupids", - "related": "createSecurityGroup", + "name": "overridediskofferingid", + "related": "createDiskOffering", "required": false, - "type": "list" + "since": "4.17", + "type": "uuid" }, { - "description": "Deploy vm for the project", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "rootdisksize", + "name": "details", "required": false, - "since": "4.4", - "type": "long" + "since": "4.3", + "type": "map" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.2", + "type": "boolean" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", - "length": 1048576, - "name": "userdata", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "ip6address", + "name": "deploymentplanner", "required": false, + "since": "4.4", "type": "string" }, { @@ -71834,26 +72113,27 @@ "type": "uuid" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "bootmode", + "name": "securitygroupids", + "related": "createSecurityGroup", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "list" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "keyboard", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "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": "deploymentplanner", + "name": "hypervisor", "required": false, - "since": "4.4", "type": "string" }, { @@ -71862,181 +72142,50 @@ "name": "customid", "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 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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "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" - }, + } + ], + "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 project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS name of the vm", + "name": "osdisplayname", "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", @@ -72046,20 +72195,30 @@ "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 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -72071,28 +72230,13 @@ "name": "account", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -72101,23 +72245,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -72126,105 +72270,145 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "the 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": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the 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": "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" } ], "type": "set" }, { - "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" }, { @@ -72232,475 +72416,641 @@ "name": "icmpcode", "type": "integer" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "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 id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of 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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "ssh key-pairs", + "name": "keypairs", + "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 list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the domain name of the affinity group", + "name": "domain", "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" - }, + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the 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", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the 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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the 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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the 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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - {}, - { - "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": "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { "description": "the outgoing network traffic on the host in KiB", @@ -72708,23 +73058,23 @@ "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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", + "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", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -72733,18 +73083,13 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -72753,68 +73098,29 @@ "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" } ] @@ -72824,6 +73130,14 @@ "isasync": false, "name": "upgradeRouterTemplate", "params": [ + { + "description": "upgrades router with the specified Id", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters", + "required": false, + "type": "uuid" + }, { "description": "upgrades all routers within the specified cluster", "length": 255, @@ -72839,22 +73153,6 @@ "required": false, "type": "string" }, - { - "description": "upgrades all routers owned by the specified domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "upgrades router with the specified Id", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", - "required": false, - "type": "uuid" - }, { "description": "upgrades all routers within the specified zone", "length": 255, @@ -72870,16 +73168,24 @@ "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" + }, + { + "description": "upgrades all routers owned by the specified domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -72905,49 +73211,88 @@ "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "capabilities of the host", + "name": "capabilities", + "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, { "description": "the OS category name of the host", "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, - {}, { - "description": "the Zone name of the host", - "name": "zonename", + "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", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { @@ -72956,14 +73301,14 @@ "type": "integer" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "the IP address of the host", @@ -72971,18 +73316,23 @@ "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { @@ -72990,35 +73340,27 @@ "name": "hostha", "type": "hostharesponse" }, - { - "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": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "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 Zone name of the host", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the name of the host", + "name": "name", + "type": "string" }, { "description": "the host hypervisor", @@ -73026,111 +73368,71 @@ "type": "hypervisortype" }, { - "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 the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the amount of the host's memory currently allocated in bytes", "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "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": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "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": "Maximum Y resolution per display", - "name": "maxresolutiony", + "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", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -73139,44 +73441,54 @@ "type": "string" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "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 after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { @@ -73185,28 +73497,33 @@ "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -73215,54 +73532,43 @@ "type": "outofbandmanagementresponse" }, { - "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "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 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 Pod name of the host", - "name": "podname", - "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 cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" } ] @@ -73273,10 +73579,10 @@ "name": "listVlanIpRanges", "params": [ { - "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": "network id of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -73289,19 +73595,26 @@ "type": "uuid" }, { - "description": "", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "page", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" }, { "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", @@ -73319,33 +73632,20 @@ "type": "uuid" }, { - "description": "network id of the VLAN IP range", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the 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": "vlan", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -73363,34 +73663,40 @@ "type": "uuid" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -73398,20 +73704,19 @@ "name": "projectid", "type": "string" }, - {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { @@ -73419,24 +73724,19 @@ "name": "description", "type": "string" }, - { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" - }, { "description": "the start ipv6 of the VLAN IP range", "name": "startipv6", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { @@ -73445,66 +73745,72 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, - {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" - } + }, + {} ] }, { @@ -73513,65 +73819,66 @@ "name": "updateZone", "params": [ { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "the second DNS for the Zone", "length": 255, - "name": "ispublic", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the dns search order list", + "description": "the name of the Zone", "length": 255, - "name": "dnssearchorder", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "guestcidraddress", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "ip6dns2", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the details for the Zone", + "description": "sort key of the zone, integer", "length": 255, - "name": "details", + "name": "sortkey", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the first DNS for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dns1", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "guestcidraddress", + "name": "dns1", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the ID of the Zone", "length": 255, - "name": "dns2", - "required": false, - "type": "string" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the first internal DNS for the Zone", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "internaldns1", + "name": "domain", "required": false, "type": "string" }, @@ -73583,12 +73890,11 @@ "type": "string" }, { - "description": "the ID of the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "internaldns1", + "required": false, + "type": "string" }, { "description": "the dhcp Provider for the Zone", @@ -73598,57 +73904,62 @@ "type": "string" }, { - "description": "the name of the Zone", + "description": "the dns search order list", "length": 255, - "name": "name", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "ip6dns1", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "allocationstate", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the details for the Zone", "length": 255, - "name": "domain", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "sort key of the zone, integer", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "sortkey", + "name": "ip6dns2", "required": false, - "type": "integer" + "type": "string" } ], "related": "createZone,listZones,listZones", "response": [ { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the 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 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", @@ -73656,9 +73967,34 @@ "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 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": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { "description": "the second IPv6 DNS for the Zone", @@ -73666,33 +74002,68 @@ "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, {}, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", "type": "string" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -73700,35 +74071,30 @@ "name": "name", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "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 Pod name", - "name": "podname", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Cluster name", @@ -73736,38 +74102,39 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "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": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Zone name", + "name": "name", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the list of resource tags associated with zone.", "name": "tags", @@ -73778,33 +74145,33 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -73813,8 +74180,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -73824,68 +74191,7 @@ } ], "type": "set" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - {} + } ] }, { @@ -73894,12 +74200,11 @@ "name": "extractVolume", "params": [ { - "description": "the ID of the zone where the volume is located", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" }, { "description": "the ID of the volume", @@ -73917,95 +74222,96 @@ "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 zone where the volume is located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "extractTemplate", "response": [ { - "description": "the name of the extracted object", - "name": "name", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, - {}, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, - {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "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 state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, + {}, + {}, { - "description": "", - "name": "resultstring", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "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" } ] @@ -74018,24 +74324,24 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "ID of the project", + "description": "list accounts of the project by project role id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": true, + "name": "projectroleid", + "related": "updateProjectRole", + "required": false, "type": "uuid" }, { - "description": "list invitation by user ID", + "description": "ID of the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { @@ -74046,17 +74352,10 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list accounts of the project by project role id", + "description": "list invitation by user ID", "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, @@ -74073,102 +74372,49 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "activateProject,suspendProject,updateProject", "response": [ { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the 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 list of resource tags associated with vm", "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": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -74176,69 +74422,102 @@ "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", + "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": "list" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the state of the project", + "name": "state", + "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "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 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 number of networks the project can own", + "name": "networklimit", "type": "string" }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, { "description": "the total number of templates available to be created by this project", "name": "templateavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the project", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "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 vpcs the project can own", + "name": "vpclimit", "type": "string" }, { @@ -74252,68 +74531,104 @@ "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", + "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 memory (in MB) the project can own", "name": "memorylimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the 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 networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -74322,39 +74637,35 @@ "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Base64 string representation of the resource icon", @@ -74362,13 +74673,8 @@ "type": "resourceiconresponse" }, { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" } ], @@ -74379,13 +74685,6 @@ "isasync": true, "name": "updateAutoScalePolicy", "params": [ - { - "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 cool down period for which the policy should not be evaluated after the action has been taken", "length": 255, @@ -74394,12 +74693,11 @@ "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the duration for which the conditions have to be true before action is taken", "length": 255, - "name": "conditionids", - "related": "", + "name": "duration", "required": false, - "type": "list" + "type": "integer" }, { "description": "the ID of the autoscale policy", @@ -74408,71 +74706,79 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "uuid" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "", + "required": false, + "type": "list" } ], "related": "listAutoScalePolicies", "response": [ { - "description": "the project id autoscale policy", - "name": "projectid", + "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" }, - {}, { - "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 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 domain ID of the autoscale policy", "name": "domainid", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the 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 domain name of the autoscale policy", - "name": "domain", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { "description": "the duration for which the conditions have to be true before action is taken", "name": "duration", "type": "integer" }, + { + "description": "the 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -74481,6 +74787,14 @@ "isasync": false, "name": "createDiskOffering", "params": [ + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "list" + }, { "description": "io requests write rate of the disk offering", "length": 255, @@ -74489,30 +74803,45 @@ "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "bytesreadrate", "required": false, - "type": "integer" + "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadrate", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "disksize", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" + }, + { + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, + "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", + "type": "string" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, @@ -74524,11 +74853,18 @@ "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "provisioningtype", + "name": "iopswriteratemaxlength", "required": false, - "type": "string" + "type": "long" + }, + { + "description": "whether disk offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "type": "boolean" }, { "description": "burst io requests write rate of the disk offering", @@ -74537,6 +74873,13 @@ "required": false, "type": "long" }, + { + "description": "an optional field, whether to display the offering to the end user or not.", + "length": 255, + "name": "displayoffering", + "required": false, + "type": "boolean" + }, { "description": "whether disk offering iops is custom or not", "length": 255, @@ -74545,26 +74888,33 @@ "type": "boolean" }, { - "description": "bytes write rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "byteswriterate", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "details to specify disk offering parameters", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "details", + "name": "byteswriteratemax", "required": false, - "since": "4.16", - "type": "map" + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "cachemode", + "name": "storagetype", "required": false, - "since": "4.14", + "type": "string" + }, + { + "description": "alternate display text of the disk offering", + "length": 4096, + "name": "displaytext", + "required": true, "type": "string" }, { @@ -74575,16 +74925,16 @@ "type": "long" }, { - "description": "alternate display text of the disk offering", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "bytesreadratemaxlength", + "name": "disksize", "required": false, "type": "long" }, @@ -74606,42 +74956,18 @@ "type": "list" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "bytes read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadrate", + "name": "byteswriteratemaxlength", "required": false, "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" - }, - { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", - "required": false, - "since": "4.15", - "type": "uuid" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "iopsreadratemax", "required": false, - "type": "list" + "type": "long" }, { "description": "name of the disk offering", @@ -74651,102 +74977,66 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "the storage type of the disk offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "type": "string" - }, - { - "description": "burst requests read rate of the disk offering", + "description": "details to specify disk offering parameters", "length": 255, - "name": "iopsreadratemax", + "name": "details", "required": false, - "type": "long" + "since": "4.16", + "type": "map" }, { - "description": "length (in seconds) of the burst", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "byteswriteratemaxlength", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopsreadrate", "required": false, "type": "long" }, { - "description": "whether disk offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "type": "boolean" - }, - { - "description": "burst bytes read rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "byteswriterate", "required": false, "type": "long" } ], "related": "", "response": [ - { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" - }, { "description": "the storage type for this disk offering", "name": "storagetype", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, - {}, - { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { "description": "bytes write rate of the disk offering", @@ -74754,84 +75044,89 @@ "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "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": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - {}, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { @@ -74840,33 +75135,33 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "an alternate display text of the disk 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": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -74875,14 +75170,25 @@ "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "unique ID of the disk offering", + "name": "id", "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": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" } ] }, @@ -74891,20 +75197,6 @@ "isasync": false, "name": "listVolumes", "params": [ - { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list volumes on specified host", "length": 255, @@ -74914,53 +75206,34 @@ "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 volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "listall", "required": false, - "since": "4.3", - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the disk volume", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displayvolume", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the cluster id the disk volume belongs to", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the IDs of the volumes, mutually exclusive with id", @@ -74972,18 +75245,20 @@ "type": "list" }, { - "description": "the type of disk volume", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "type", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "tags", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "map" + "type": "uuid" }, { "description": "the pod id the disk volume belongs to", @@ -74993,6 +75268,13 @@ "required": false, "type": "uuid" }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "the ID of the availability zone", "length": 255, @@ -75002,42 +75284,66 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the disk volume", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the 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": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", + "type": "string" }, { "description": "", @@ -75047,90 +75353,75 @@ "type": "integer" }, { - "description": "the name of the disk volume", + "description": "the type of disk volume", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" } ], "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "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": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -75139,33 +75430,28 @@ "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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": "pod id of the volume", - "name": "podid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -75174,38 +75460,8 @@ "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { @@ -75214,94 +75470,67 @@ "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "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": "ID of the availability zone", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, - {}, - {}, { - "description": "size of the disk volume", - "name": "size", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -75309,14 +75538,19 @@ "name": "key", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -75325,13 +75559,13 @@ "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" }, { @@ -75340,117 +75574,189 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "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 domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "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 state of the disk volume", - "name": "state", + "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 account associated with the disk volume", - "name": "account", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" } ] }, @@ -75460,18 +75766,26 @@ "name": "createLBHealthCheckPolicy", "params": [ { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "the ID of the load balancer rule", "length": 255, - "name": "healthythreshold", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "length": 255, + "name": "responsetimeout", "required": false, "type": "integer" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "responsetimeout", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { "description": "HTTP ping path", @@ -75481,11 +75795,11 @@ "type": "string" }, { - "description": "the description of the load balancer health check policy", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "description", + "name": "healthythreshold", "required": false, - "type": "string" + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -75495,13 +75809,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "Amount of time between health checks (1 sec - 20940 sec)", - "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" - }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, @@ -75510,99 +75817,98 @@ "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "intervaltime", + "required": false, + "type": "integer" } ], "related": "listLBHealthCheckPolicies", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "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", + "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", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "the state of the policy", - "name": "state", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" } ], "type": "list" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "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", @@ -75629,57 +75935,61 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the name of the role", "name": "rolename", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "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 date and time the user account was created", + "name": "created", + "type": "date" }, { - "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" }, {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, - {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, { "description": "the user ID", "name": "id", @@ -75691,63 +76001,59 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", + "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" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "type": "string" }, + {}, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the type of the role", + "name": "roletype", "type": "string" } ] @@ -75759,12 +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", @@ -75775,11 +76086,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" } ], "since": "4.11.0" @@ -75790,20 +76096,11 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "the ID of the health check policy", @@ -75822,11 +76119,20 @@ "type": "string" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { "description": "", @@ -75838,30 +76144,45 @@ ], "related": "", "response": [ + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, { "description": "the state of the policy", "name": "state", "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, { "description": "is policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, { "description": "the pingpath of the healthcheck policy", "name": "pingpath", @@ -75872,59 +76193,44 @@ "name": "healthcheckthresshold", "type": "int" }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, { "description": "Time to wait when receiving a response from the health check", "name": "responsetime", "type": "int" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" } ], "type": "list" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, {}, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "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" } ], @@ -75936,123 +76242,128 @@ "name": "createNetwork", "params": [ { - "description": "Network ACL ID associated for the network", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "ip6cidr", "required": false, + "type": "string" + }, + { + "description": "the network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, "type": "uuid" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "routerip", + "name": "routeripv6", "required": false, "since": "4.16", "type": "string" }, { - "description": "the beginning IP address in the network IP range", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "startip", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "gateway", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "account that will own the network", + "description": "the display text of the network", "length": 255, - "name": "account", - "required": false, + "name": "displaytext", + "required": true, "type": "string" }, { - "description": "an optional project for the network", + "description": "the zone ID for the network", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "routeripv6", + "name": "startip", "required": false, - "since": "4.16", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "network domain", "length": 255, - "name": "hideipaddressusage", + "name": "networkdomain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the network in an external system.", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "externalid", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the ID or VID of the network", + "description": "account that will own the network", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, { - "description": "the network offering ID", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "the physical network ID the network belongs to", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "displaynetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the display text of the network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "displaytext", - "required": true, + "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 VPC network belongs to", + "description": "ID of the network in an external system.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "externalid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "the name of the network", "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", @@ -76062,104 +76373,99 @@ "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "displaynetwork", + "name": "gateway", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "ip6gateway", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the zone ID for the network", + "description": "domain ID of the account owning a network", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" }, { - "description": "the name of the network", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", "length": 255, - "name": "name", - "required": true, + "name": "acltype", + "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "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": "ip6cidr", + "name": "subdomainaccess", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the isolated private VLAN type for this network", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "isolatedpvlantype", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "an optional project for the network", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "network domain", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "networkdomain", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "subdomainaccess", + "name": "hideipaddressusage", "required": false, "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", - "length": 255, - "name": "acltype", - "required": false, - "type": "string" - }, - { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "startipv6", + "name": "endip", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a network", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "routerip", "required": false, - "type": "uuid" + "since": "4.16", + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the VPC network belongs to", "length": 255, - "name": "endipv6", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "the ID or VID of the network", "length": 255, - "name": "endip", + "name": "vlan", "required": false, "type": "string" } @@ -76167,23 +76473,18 @@ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { @@ -76192,23 +76493,24 @@ "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the owner of the network", + "name": "account", "type": "string" }, + {}, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { @@ -76217,59 +76519,48 @@ "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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": "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": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "state of the network", + "name": "state", "type": "string" }, - {}, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the network", + "name": "name", "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": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { @@ -76278,118 +76569,158 @@ "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "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": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the zone the network belongs to", + "name": "zonename", "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": "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 external id of the network", - "name": "externalid", + "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": "Name of the VPC to which this network belongs", "name": "vpcname", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -76397,18 +76728,18 @@ "name": "tags", "response": [ { - "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": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -76417,13 +76748,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -76432,82 +76763,90 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the name of the network", - "name": "name", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the first DNS for the network", - "name": "dns1", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, { "description": "the service provider name", "name": "provider", @@ -76522,16 +76861,6 @@ "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", @@ -76543,31 +76872,19 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "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" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" } ], "type": "list" @@ -76581,56 +76898,45 @@ "type": "list" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the type of the network", + "name": "type", "type": "string" - }, - {} + } ] }, { @@ -76638,42 +76944,6 @@ "isasync": false, "name": "listNetworkOfferings", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "true if offering has tags specified", - "length": 255, - "name": "istagged", - "required": false, - "type": "boolean" - }, - { - "description": "list network offerings by guest type: shared or isolated", - "length": 255, - "name": "guestiptype", - "required": false, - "type": "string" - }, - { - "description": "the tags for the network offering.", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, { "description": "list by traffic type", "length": 255, @@ -76682,11 +76952,11 @@ "type": "string" }, { - "description": "list network offerings by display text", + "description": "true if offering has tags specified", "length": 255, - "name": "displaytext", + "name": "istagged", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list network offerings by name", @@ -76703,19 +76973,18 @@ "type": "list" }, { - "description": "", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "pagesize", + "name": "isdefault", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "list network offerings by display text", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", @@ -76731,29 +77000,6 @@ "required": false, "type": "string" }, - { - "description": "list network offerings available for network creation in specific domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "the network offering can be used only for network creation inside the VPC", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" - }, { "description": "list network offerings by ID", "length": 255, @@ -76763,16 +77009,16 @@ "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": "true if need to list only network offerings which support specifying ip ranges", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "specifyipranges", + "name": "forvpc", "required": false, "type": "boolean" }, @@ -76784,99 +77030,111 @@ "type": "string" }, { - "description": "the availability of network offering. Default value is required", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "availability", + "name": "specifyipranges", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the availability of network offering. Default value is required", + "length": 255, + "name": "availability", + "required": false, "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the id of the network offering", - "name": "id", - "type": "string" + "description": "list network offerings available for network creation in specific domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "since": "4.13", + "type": "uuid" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the tags for the network offering.", + "length": 255, + "name": "specifyvlan", + "required": false, "type": "boolean" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", + "required": false, "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, + "description": "list network offerings available for network creation in specific zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { "description": "true if network offering supports public access for guest networks", "name": "supportspublicaccess", "type": "boolean" }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, + {}, + {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -76886,43 +77144,28 @@ "name": "name", "type": "string" }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "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": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -76934,14 +77177,24 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { "description": "uuid of the network provider", "name": "id", "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -76949,56 +77202,104 @@ ], "type": "list" }, - {}, { - "description": "availability of the network offering", - "name": "availability", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the id of the network offering", + "name": "id", + "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": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, { "description": "the ID of the service offering used by virtual router provider", "name": "serviceofferingid", "type": "string" }, - { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" - }, - {}, { "description": "the 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 is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "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" }, { @@ -77007,19 +77308,24 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "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 network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "true if 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" } ] }, @@ -77029,18 +77335,18 @@ "name": "listDedicatedPods", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the domain associated with the pod", @@ -77051,18 +77357,19 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "account", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the pod", @@ -77073,12 +77380,11 @@ "type": "uuid" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", @@ -77089,9 +77395,9 @@ "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Account Id to which the Pod is dedicated", @@ -77099,8 +77405,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { @@ -77108,23 +77414,23 @@ "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 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 ID of the Pod", - "name": "podid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -77132,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, @@ -77154,499 +77452,204 @@ "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": "device type of the root volume", - "name": "rootdevicetype", + "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 ID of the affinity group", - "name": "projectid", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 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": "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" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "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": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "resource type", + "name": "resourcetype", + "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "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 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 name of the virtual machine", + "name": "name", "type": "string" }, { @@ -77659,28 +77662,23 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -77689,13 +77687,13 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -77703,64 +77701,74 @@ "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -77769,143 +77777,102 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the total number of network traffic bytes sent", @@ -77913,150 +77880,452 @@ "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, { "description": "the memory used by the VM in KiB", "name": "memorykbs", "type": "long" }, { - "description": "the 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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the 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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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": "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "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", + "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": "OS type id of the vm", - "name": "ostypeid", + "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", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -78065,49 +78334,96 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" } ] }, @@ -78117,263 +78433,218 @@ "name": "listVPCs", "params": [ { - "description": "", + "description": "List by display text of the VPC", "length": 255, - "name": "pagesize", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list VPC by id", "length": 255, - "name": "account", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list VPC supporting certain services", + "description": "list VPCs by state", "length": 255, - "name": "supportedservices", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "list by name of the VPC", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "cidr", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by display text of the VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displaytext", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list VPCs by restartRequired option", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "restartrequired", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list by zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list VPCs by state", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "state", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by ID of the VPC offering", + "description": "", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list VPC supporting certain services", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by name of the VPC", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by zone", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "flag to display the resource icon for VPCs", + "description": "list by ID of the VPC offering", "length": 255, - "name": "showicon", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC by id", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "cidr", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + { + "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 cidr the VPC", "name": "cidr", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + {}, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "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 network domain of the VPC", + "name": "networkdomain", + "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" }, { @@ -78382,39 +78653,38 @@ "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 name of the zone the VPC belongs to", - "name": "zonename", + "description": "the id of the VPC", + "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 VPC", "name": "name", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { @@ -78423,23 +78693,38 @@ "type": "boolean" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "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": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -78448,92 +78733,164 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" } ], "type": "list" - }, + } + ] + }, + { + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", + "isasync": false, + "name": "addNetworkDevice", + "params": [ { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": false, + "type": "string" }, + { + "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": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the id of the VPC", + "description": "the ID of the network device", "name": "id", "type": "string" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" } ] }, @@ -78550,13 +78907,6 @@ "required": true, "type": "uuid" }, - { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, { "description": "The IP/Domain address to test connection to", "length": 255, @@ -78570,19 +78920,20 @@ "name": "params", "required": false, "type": "string" + }, + { + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "length": 255, + "name": "type", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "the standard error output from the command execution", + "name": "stderr", "type": "string" }, { @@ -78590,60 +78941,25 @@ "name": "exitcode", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the standard error output from the command execution", - "name": "stderr", + "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", @@ -78651,73 +78967,73 @@ "name": "updateUser", "params": [ { - "description": "first name", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "firstname", + "name": "usersecretkey", "required": false, "type": "string" }, { - "description": "email", + "description": "Unique username", "length": 255, - "name": "email", + "name": "username", "required": false, "type": "string" }, { - "description": "last name", + "description": "first name", "length": 255, - "name": "lastname", + "name": "firstname", "required": false, "type": "string" }, { - "description": "Unique username", + "description": "email", "length": 255, - "name": "username", + "name": "email", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "timezone", + "name": "currentpassword", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "User uuid", "length": 255, - "name": "usersecretkey", - "required": false, - "type": "string" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "required": true, + "type": "uuid" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "password", + "name": "userapikey", "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": "last name", "length": 255, - "name": "currentpassword", + "name": "lastname", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, - "type": "uuid" + "name": "timezone", + "required": false, + "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", "length": 255, - "name": "userapikey", + "name": "password", "required": false, "type": "string" } @@ -78725,60 +79041,65 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ { - "description": "the api key of the user", - "name": "apikey", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { "description": "the user lastname", "name": "lastname", "type": "string" }, - {}, { - "description": "the domain name of the user", - "name": "domain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, - {}, { "description": "the user state", "name": "state", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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 account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -78792,48 +79113,28 @@ "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, { - "description": "the 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 ID", - "name": "id", + "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", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -78841,10 +79142,25 @@ "name": "email", "type": "string" }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, { "description": "the user firstname", "name": "firstname", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -78854,11 +79170,12 @@ "name": "restartVPC", "params": [ { - "description": "If cleanup old network elements", + "description": "the id of the VPC", "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", @@ -78876,36 +79193,35 @@ "type": "boolean" }, { - "description": "the id of the VPC", + "description": "If cleanup old network elements", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "cleanup", + "required": false, + "type": "boolean" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -78924,11 +79240,7 @@ } ], "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", @@ -78939,7 +79251,11 @@ "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", @@ -78953,21 +79269,6 @@ "isasync": false, "name": "addHost", "params": [ - { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, { "description": "the cluster ID for the host", "length": 255, @@ -78977,11 +79278,11 @@ "type": "uuid" }, { - "description": "list of tags to be added to the host", + "description": "the host URL", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "url", + "required": true, + "type": "string" }, { "description": "the password for the host; required to be passed for hypervisors other than VMWare", @@ -78991,12 +79292,19 @@ "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "username", + "name": "allocationstate", "required": false, "type": "string" }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + }, { "description": "the Pod ID for the host", "length": 255, @@ -79013,16 +79321,24 @@ "type": "string" }, { - "description": "the host URL", + "description": "the Zone ID for the host", "length": 255, - "name": "url", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "username", "required": false, "type": "string" } @@ -79030,28 +79346,48 @@ "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "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 amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -79068,23 +79404,28 @@ "name": "vgpu", "response": [ { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -79093,18 +79434,13 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" } ], @@ -79114,9 +79450,9 @@ "type": "list" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { "description": "true if the host is disconnected. False otherwise.", @@ -79124,33 +79460,28 @@ "type": "date" }, { - "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", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "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" }, { @@ -79159,65 +79490,59 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "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 last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, + {}, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, - {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { @@ -79226,24 +79551,29 @@ "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "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 amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "the amount of the host's memory currently allocated in percentage", @@ -79251,74 +79581,80 @@ "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "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 host type", "name": "type", "type": "type" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the 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 incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { "description": "the hypervisor version", @@ -79326,69 +79662,49 @@ "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" } ] }, @@ -79397,14 +79713,6 @@ "isasync": true, "name": "attachVolume", "params": [ - { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, { "description": "the ID of the disk volume", "length": 255, @@ -79414,103 +79722,53 @@ "type": "uuid" }, { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. 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.", + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", "length": 255, "name": "deviceid", "required": false, "type": "long" + }, + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" } ], "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, { "description": "id of the virtual machine", "name": "virtualmachineid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { @@ -79519,48 +79777,48 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -79569,65 +79827,49 @@ "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 path of the volume", - "name": "path", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "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", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { "description": "bytes read rate of the disk volume", @@ -79635,98 +79877,97 @@ "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "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", + "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": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "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 value", + "name": "value", "type": "string" }, { @@ -79739,47 +79980,42 @@ "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": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -79788,18 +80024,93 @@ "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", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "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", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "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" }, { @@ -79808,9 +80119,14 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" } ] }, @@ -79820,16 +80136,9 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "URL of the external dhcp appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "Credentials to reach external dhcp device", + "description": "Type of dhcp device", "length": 255, - "name": "password", + "name": "dhcpservertype", "required": true, "type": "string" }, @@ -79849,36 +80158,29 @@ "type": "string" }, { - "description": "Type of dhcp device", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "dhcpservertype", + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "URL of the external dhcp appliance.", + "length": 255, + "name": "url", "required": true, "type": "string" } ], "related": "listBaremetalDhcp", "response": [ - {}, - { - "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": "url", "name": "url", "type": "string" }, - { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -79889,11 +80191,25 @@ "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", "type": "string" + }, + { + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" } ] }, @@ -79911,16 +80227,16 @@ "type": "uuid" }, { - "description": "Traffic going into the listed zones will not be metered", + "description": "Traffic going into the listed zones will be metered", "length": 255, - "name": "excludezones", + "name": "includezones", "required": false, "type": "string" }, { - "description": "Traffic going into the listed zones will be metered", + "description": "Traffic going into the listed zones will not be metered", "length": 255, - "name": "includezones", + "name": "excludezones", "required": false, "type": "string" }, @@ -79935,41 +80251,41 @@ "related": "", "response": [ { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the external firewall", - "name": "id", + "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 number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -79979,19 +80295,18 @@ "name": "updateProject", "params": [ { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "display text of the project", "length": 255, - "name": "roletype", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "roletype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "new Admin account for the project", @@ -80001,11 +80316,19 @@ "type": "string" }, { - "description": "display text of the project", + "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": "displaytext", + "name": "swapowner", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "ID of the user to be promoted/demoted", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers", + "required": false, + "type": "uuid" }, { "description": "id of the project to be modified", @@ -80014,51 +80337,39 @@ "related": "activateProject,suspendProject,updateProject", "required": true, "type": "uuid" - }, - { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", - "length": 255, - "name": "swapowner", - "required": false, - "type": "boolean" } ], "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 snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { "description": "the domain name where the project belongs to", @@ -80066,34 +80377,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the total number of virtual machines stopped for this project", @@ -80101,70 +80392,54 @@ "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "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 primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, - {}, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { "description": "the total number of snapshots available for this project", @@ -80172,38 +80447,42 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "the state of the project", - "name": "state", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -80212,23 +80491,18 @@ "type": "string" }, { - "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": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -80237,36 +80511,47 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { @@ -80275,48 +80560,79 @@ "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, + {}, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, { "description": "the total number of vpcs the project can own", "name": "vpclimit", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" } ], @@ -80328,26 +80644,26 @@ "name": "listLoadBalancers", "params": [ { - "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": "the ID of the load balancer", + "description": "the source IP address of the load balancer", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", + "name": "sourceipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "", "length": 255, - "name": "scheme", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -80370,18 +80686,10 @@ "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, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -80393,13 +80701,6 @@ "required": false, "type": "uuid" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the network ID of the load balancer", "length": 255, @@ -80408,6 +80709,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -80417,31 +80725,39 @@ "type": "uuid" }, { - "description": "", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "pagesize", + "name": "scheme", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the load balancer", "length": 255, - "name": "keyword", + "name": "id", + "related": "updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the source IP address of the load balancer", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "sourceipaddress", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" } @@ -80449,33 +80765,32 @@ "related": "createLoadBalancer", "response": [ { - "description": "the account of the Load Balancer", - "name": "account", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, - {}, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ { - "description": "the state of the instance", - "name": "state", + "description": "the name of the instance", + "name": "name", "type": "string" }, { @@ -80484,46 +80799,114 @@ "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the state of the instance", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "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": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + {}, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, {}, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -80532,104 +80915,37 @@ "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "resource type", "name": "resourcetype", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "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": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" } ], "since": "4.2.0" @@ -80640,69 +80956,69 @@ "name": "listUsers", "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": "", + "description": "List user by ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "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": "List user by the username", + "description": "", "length": 255, - "name": "username", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List user by ID.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List users by state of the user account.", @@ -80712,90 +81028,96 @@ "type": "string" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "List user by the username", "length": 255, - "name": "accounttype", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "flag to display the resource icon for users", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createUser,disableUser,enableUser,getUser", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the 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 ID of the role", - "name": "roleid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user name", + "name": "username", "type": "string" }, + {}, { - "description": "true if user 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 account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "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 domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user lastname", + "name": "lastname", "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 secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -80804,30 +81126,35 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account name of the user", + "name": "account", "type": "string" }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, { "description": "the api key of the user", "name": "apikey", "type": "string" }, + {}, { "description": "the user state", "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, - {}, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the user firstname", @@ -80835,19 +81162,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -80868,28 +81184,28 @@ ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the api key of the registered user", "name": "apikey", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the secret key of the registered user", "name": "secretkey", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -80907,13 +81223,18 @@ } ], "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", @@ -80923,11 +81244,6 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" @@ -80938,26 +81254,25 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "ip6cidr", + "name": "startip", "required": false, "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "endipv6", + "name": "endip", "required": false, "type": "string" }, { - "description": "the UUID of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" + "name": "forsystemvms", + "required": false, + "type": "boolean" }, { "description": "the beginning IPv6 address in the IPv6 network range", @@ -80967,30 +81282,31 @@ "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "startip", - "required": false, - "type": "string" + "name": "id", + "related": "updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "endip", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "forsystemvms", + "name": "ip6gateway", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the gateway of the IPv6 network", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "netmask", "required": false, "type": "string" }, @@ -81002,9 +81318,9 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "netmask", + "name": "endipv6", "required": false, "type": "string" } @@ -81012,136 +81328,136 @@ "related": "dedicatePublicIpRange", "response": [ { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "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 network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, + {}, { "description": "the gateway of IPv6 network", "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 ID of the VLAN IP range", + "name": "id", + "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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" } ], "since": "4.16.0" @@ -81152,48 +81468,41 @@ "name": "listVpnConnections", "params": [ { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List 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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "id of the vpn connection", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createVpnConnection,listVpnConnections", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "id of the vpn connection", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createVpnConnection,listVpnConnections", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "id of vpc", @@ -81204,88 +81513,79 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list 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 resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createVpnConnection", "response": [ - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, { "description": "public ip address id of the customer gateway", "name": "gateway", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "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": "IPsec Preshared-Key of the customer gateway", "name": "ipsecpsk", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { "description": "if DPD is enabled for customer gateway", @@ -81293,33 +81593,38 @@ "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -81327,51 +81632,62 @@ "name": "created", "type": "date" }, + {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the connection ID", + "name": "id", "type": "string" }, - {}, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "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": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -81381,34 +81697,25 @@ "name": "listResourceLimits", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "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": "keyword", + "name": "resourcetype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "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. ", @@ -81418,39 +81725,41 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Lists resource limits by ID.", @@ -81458,50 +81767,30 @@ "name": "id", "required": false, "type": "long" - } - ], - "related": "", - "response": [ - { - "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 domain name of the resource limit", - "name": "domain", - "type": "string" - }, - { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", - "type": "string" }, - {}, { - "description": "the account of the resource limit", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" - }, - { - "description": "the project id of the resource limit", - "name": "projectid", - "type": "string" - }, + } + ], + "related": "", + "response": [ { "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", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { @@ -81513,7 +81802,34 @@ "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": "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 domain name of the resource limit", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the resource limit", + "name": "account", + "type": "string" + }, + {} ] }, { @@ -81532,20 +81848,26 @@ ], "related": "createUser,enableUser,getUser", "response": [ + {}, + { + "description": "the api key of the user", + "name": "apikey", + "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 ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the domain name of the user", @@ -81553,105 +81875,99 @@ "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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 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 type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the 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 domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user state", + "name": "state", + "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 user ID", - "name": "id", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the type of the role", + "name": "roletype", "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 timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, + {}, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", "name": "usersource", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -81662,63 +81978,69 @@ "name": "listIsos", "params": [ { - "description": "If set to true, list only unique isos across zones", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "showunique", + "name": "ispublic", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ispublic", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "flag to display the resource image for the isos", + "description": "list ISO by ID", "length": 255, - "name": "showicon", + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + }, + { + "description": "true if this ISO is ready to be deployed", + "length": 255, + "name": "isready", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isofilter", "required": false, - "type": "uuid" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "show removed ISOs as well", "length": 255, - "name": "isrecursive", + "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 the ISO is bootable, false otherwise", @@ -81728,12 +82050,11 @@ "type": "boolean" }, { - "description": "list ISO by ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list all ISOs by name", @@ -81743,60 +82064,55 @@ "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "page", + "name": "showunique", "required": false, - "type": "integer" + "since": "4.13.2", + "type": "boolean" }, { - "description": "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": "true if this ISO is ready to be deployed", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "isready", + "name": "showicon", "required": false, "type": "boolean" }, { - "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": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "show removed ISOs as well", + "description": "", "length": 255, - "name": "showremoved", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the ID of the zone", @@ -81810,125 +82126,80 @@ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", "name": "deployasisdetails", "type": "map" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the template ID", + "name": "id", + "type": "string" }, { "description": "the template ID of the parent template if present", @@ -81936,25 +82207,15 @@ "type": "string" }, { - "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": "the account id to which the template belongs", + "name": "accountid", + "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 this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, { "description": "the date this template was created", "name": "created", @@ -81966,95 +82227,155 @@ "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "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" }, { - "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": "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { @@ -82063,55 +82384,50 @@ "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, + {}, { - "description": "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": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } ] }, @@ -82120,6 +82436,13 @@ "isasync": false, "name": "updateCloudToUseObjectStore", "params": [ + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, { "description": "the name for the image store", "length": 255, @@ -82140,21 +82463,14 @@ "name": "url", "required": false, "type": "string" - }, - { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" } ], "related": "listSwifts,addImageStoreS3,listImageStores", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the scope of the image store", @@ -82162,54 +82478,44 @@ "type": "scopetype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", + "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 host's currently used disk size", - "name": "disksizeused", + "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 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": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -82218,11 +82524,21 @@ "type": "boolean" }, { - "description": "the ID of the image store", - "name": "id", + "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" }, @@ -82232,25 +82548,33 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "listall", + "name": "vmgroupid", + "related": "listAutoScaleVmGroups", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", + "required": false, + "type": "string" }, { "description": "the ID of the condition of the policy", @@ -82269,41 +82593,33 @@ "type": "uuid" }, { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", - "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 ID of the autoscale policy", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "account", "required": false, - "type": "uuid" + "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": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "action", + "name": "id", + "related": "listAutoScalePolicies", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -82316,20 +82632,10 @@ "related": "", "response": [ { - "description": "the project name of the autoscale policy", - "name": "project", - "type": "string" - }, - { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the duration for which the conditions have to be true before action is taken", "name": "duration", @@ -82341,19 +82647,29 @@ "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "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 cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the account owning the autoscale policy", @@ -82362,20 +82678,20 @@ }, {}, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" } ] }, @@ -82394,26 +82710,26 @@ ], "related": "", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "url", "name": "url", "type": "string" }, - {}, { - "description": "id of rct", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of rct", + "name": "id", "type": "string" } ] @@ -82424,9 +82740,17 @@ "name": "updateRole", "params": [ { - "description": "The description of the role", + "description": "ID of the role", "length": 255, - "name": "description", + "name": "id", + "related": "importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", "required": false, "type": "string" }, @@ -82437,14 +82761,6 @@ "required": false, "type": "string" }, - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - }, { "description": "The description of the role", "length": 255, @@ -82453,33 +82769,28 @@ "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "The description of the role", "length": 255, - "name": "type", + "name": "description", "required": false, "type": "string" } ], "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": "the description of the role", - "name": "description", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -82487,18 +82798,23 @@ "name": "id", "type": "string" }, - {}, - {}, { "description": "the name of the role", "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" - } + }, + {}, + {} ], "since": "4.9.0" }, @@ -82508,53 +82824,52 @@ "name": "listVmwareDcs", "params": [ { - "description": "List by keyword", + "description": "Id of the CloudStack zone.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Id of the CloudStack zone.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addVmwareDc", "response": [ + {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, - {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" }, { "description": "the Zone ID associated with this VMware Datacenter", @@ -82562,15 +82877,16 @@ "type": "long" }, { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -82578,49 +82894,34 @@ "isasync": false, "name": "listZones", "params": [ - { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", - "length": 255, - "name": "available", - "required": false, - "type": "boolean" - }, - { - "description": "List zones by resource tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "since": "4.3", - "type": "map" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the zone", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "available", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the resource image for the zones", + "description": "the name of the zone", "length": 255, - "name": "showicon", + "name": "name", "required": false, - "type": "boolean" + "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", @@ -82629,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, @@ -82637,41 +82946,46 @@ "type": "boolean" }, { - "description": "the name of the zone", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the domain associated with the zone", + "description": "the ID of the zone", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createZone,listZones", "response": [ { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, - {}, - {}, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { "description": "the first DNS for the Zone", @@ -82679,23 +82993,23 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Zone description", + "name": "description", "type": "string" }, { @@ -82704,32 +83018,57 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, { "description": "the capacity name", "name": "name", "type": "string" }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, { "description": "the Cluster name", "name": "clustername", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -82738,9 +83077,9 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity type", @@ -82748,83 +83087,38 @@ "type": "short" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" } ], "type": "list" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, { "description": "Zone id", "name": "id", "type": "string" }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, { "description": "the list of resource tags associated with zone.", "name": "tags", @@ -82835,13 +83129,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -82850,18 +83139,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -82870,26 +83154,31 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "the account associated with the tag", "name": "account", "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 allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { @@ -82898,19 +83187,46 @@ "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "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": "Network domain name for the networks in the zone", - "name": "domain", + "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" } ] }, @@ -82919,6 +83235,13 @@ "isasync": false, "name": "listRemoteAccessVpns", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "Lists remote access vpn rule with the specified ID", "length": 255, @@ -82929,25 +83252,20 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "list remote access VPNs for ceratin network", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "since": "4.3", + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -82957,21 +83275,11 @@ "type": "boolean" }, { - "description": "list remote access VPNs for ceratin network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -82982,17 +83290,17 @@ "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": "public ip address id of the vpn server", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, @@ -83004,6 +83312,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -83015,50 +83331,60 @@ "related": "updateRemoteAccessVpn", "response": [ { - "description": "the state of the rule", - "name": "state", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "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", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, - {}, { "description": "is vpn for display to the regular user", "name": "fordisplay", "type": "boolean" }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, + {}, { - "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" }, { @@ -83067,24 +83393,14 @@ "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 public ip address of the vpn server", "name": "publicipid", "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" } ] }, @@ -83103,27 +83419,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", - "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" } ] }, @@ -83153,17 +83469,17 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -83171,13 +83487,6 @@ "isasync": true, "name": "createServiceInstance", "params": [ - { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "The left (inside) network for service instance", "length": 255, @@ -83187,11 +83496,11 @@ "type": "uuid" }, { - "description": "The right (outside) network ID for the service instance", + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" }, { @@ -83203,26 +83512,18 @@ "type": "uuid" }, { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Project ID for the service instance", + "description": "Availability zone for the service instance", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "Availability zone for the service instance", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, @@ -83234,40 +83535,60 @@ "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, "name": "account", "required": false, "type": "string" + }, + { + "description": "Project ID for the service instance", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -83277,23 +83598,18 @@ }, {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } ] @@ -83313,16 +83629,14 @@ } ], "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "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" }, { @@ -83334,7 +83648,9 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ] }, { @@ -83342,13 +83658,6 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "netscaler load balancer device ID", "length": 255, @@ -83357,138 +83666,60 @@ "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,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "response": [ - { - "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 network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, + {}, { "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the date this network was created", @@ -83496,94 +83727,93 @@ "type": "date" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the physical network id", + "name": "physicalnetworkid", "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": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The routing mode of network offering", + "name": "ip6routing", + "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 owner of the network", + "name": "account", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - {}, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -83592,94 +83822,147 @@ "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", @@ -83687,156 +83970,189 @@ "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "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 ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 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 service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "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": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "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 displaytext of the network", - "name": "displaytext", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" } ] @@ -83858,73 +84174,70 @@ "related": "migrateSystemVm", "response": [ { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, + {}, + {}, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { @@ -83933,23 +84246,28 @@ "type": "integer" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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 name of the system VM", - "name": "name", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "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" }, { @@ -83958,33 +84276,33 @@ "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 first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "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": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -83993,101 +84311,103 @@ "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 template ID for the system VM", - "name": "templateid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the system VM type", - "name": "systemvmtype", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, - {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" } ] }, { - "description": "Lists host HA resources", + "description": "Lists supported methods of network isolation", "isasync": false, - "name": "listHostHAResources", + "name": "listNetworkIsolationMethods", "params": [ { - "description": "List by host ID", + "description": "", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "related": "", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "Network isolation method name", + "name": "name", "type": "string" }, {}, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -84097,69 +84417,65 @@ "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 host HA provider", - "name": "haprovider", - "type": "string" } ], - "since": "4.11" + "since": "4.2.0" }, { - "description": "Lists supported methods of network isolation", + "description": "Lists host HA resources", "isasync": false, - "name": "listNetworkIsolationMethods", + "name": "listHostHAResources", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by host ID", "length": 255, - "name": "page", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "", + "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": "Network isolation method name", - "name": "name", + "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.2.0" + "since": "4.11" }, { "description": "Lists VM stats", @@ -84167,24 +84483,31 @@ "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "the IDs of the virtual machines, mutually exclusive with id.", + "description": "end date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "ids", + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "start date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -84196,12 +84519,12 @@ "type": "string" }, { - "description": "the ID of the virtual machine.", + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "id", + "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": "uuid" + "type": "list" }, { "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", @@ -84211,28 +84534,32 @@ "type": "string" }, { - "description": "end date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "start date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" } ], "related": "", "response": [ + { + "description": "the list of VM stats", + "name": "stats", + "type": "list" + }, {}, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "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", @@ -84243,21 +84570,10 @@ "name": "name", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the list of VM stats", - "name": "stats", - "type": "list" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" } ], "since": "4.17" @@ -84279,41 +84595,67 @@ "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "response": [ { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, + {}, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ + { + "description": "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": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -84322,18 +84664,13 @@ "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -84342,60 +84679,50 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "the Pod ID of the host", @@ -84403,155 +84730,133 @@ "type": "string" }, { - "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "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 amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "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", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { + "description": "the 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 IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the 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 host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the ID of the host", + "name": "id", "type": "string" }, { @@ -84560,84 +84865,95 @@ "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + {}, + { + "description": "true if this host 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 used", + "name": "memoryused", + "type": "long" + }, { "description": "the host type", "name": "type", "type": "type" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "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 resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.16.0.0" @@ -84648,63 +84964,55 @@ "name": "createKubernetesCluster", "params": [ { - "description": "name of the ssh key pair used to login to the virtual machines", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - }, - { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "root disk size in GB for each node", "length": 255, - "name": "controlnodes", + "name": "noderootdisksize", "required": false, "type": "long" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "externalloadbalanceripaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "dockerregistryusername", - "required": false, - "type": "string" + "name": "size", + "required": true, + "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": true, "type": "uuid" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "masternodes", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "password for the docker image private registry", "length": 255, - "name": "size", - "required": true, - "type": "long" + "name": "dockerregistrypassword", + "required": false, + "type": "string" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { "description": "name for the Kubernetes cluster", @@ -84714,154 +85022,170 @@ "type": "string" }, { - "description": "password for the docker image private registry", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "dockerregistrypassword", - "required": false, + "name": "description", + "required": true, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "URL for the docker image private registry", "length": 255, - "name": "description", - "required": true, + "name": "dockerregistryurl", + "required": false, "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "Deploy cluster for the project", "length": 255, - "name": "noderootdisksize", + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "number of Kubernetes cluster control nodes, default is 1", + "length": 255, + "name": "controlnodes", "required": false, "type": "long" }, { - "description": "URL for the docker image private registry", + "description": "user name for the docker image private registry", "length": 255, - "name": "dockerregistryurl", + "name": "dockerregistryusername", "required": false, "type": "string" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "masternodes", + "required": false, + "type": "long" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "externalloadbalanceripaddress", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "Deploy cluster for the project", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "startKubernetesCluster", "response": [ { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "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 domain in which the Kubernetes cluster exists", - "name": "domain", + "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": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { @@ -84870,44 +85194,55 @@ "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, { "description": "the name of the service offering of the Kubernetes cluster", "name": "serviceofferingname", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { "description": "the project name of the Kubernetes cluster", @@ -84915,29 +85250,25 @@ "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "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 memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -84945,19 +85276,9 @@ "type": "boolean" }, { - "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 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" } ] }, @@ -84967,88 +85288,96 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "List by keyword", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, - {}, { "description": "the network uuid of storage network IP range", "name": "networkid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the netmask of the storage network IP range", + "name": "netmask", + "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85056,61 +85385,38 @@ "name": "id", "type": "string" }, + {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "3.0.0" }, { - "description": "Enables HA for a host", + "description": "Deletes a specified domain", "isasync": true, - "name": "enableHAForHost", + "name": "deleteDomain", "params": [ { - "description": "ID of the host", + "description": "ID of domain to delete", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "id", + "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" - } - ], - "related": "configureHAForHost,disableHAForHost,listHostHAProviders", - "response": [ - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" }, { - "description": "operation status", - "name": "status", + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, "type": "boolean" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -85118,17 +85424,22 @@ }, {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.11" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] }, { "description": "Configures a virtual router element.", @@ -85136,52 +85447,57 @@ "name": "configureVirtualRouterElement", "params": [ { - "description": "the ID of the virtual router provider", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", + "description": "the ID of the virtual router provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": true, - "type": "boolean" + "type": "uuid" } ], "related": "listVirtualRouterElements", "response": [ + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, - {}, { "description": "the domain associated with the provider", "name": "domain", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -85190,68 +85506,73 @@ "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 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": "Deletes a specified domain", + "description": "Enables HA for a host", "isasync": true, - "name": "deleteDomain", + "name": "enableHAForHost", "params": [ { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, - { - "description": "ID of domain to delete", + "description": "ID of the host", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], + "related": "configureHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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 HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] + {} + ], + "since": "4.11" }, { "description": "Migrate volume", @@ -85259,11 +85580,11 @@ "name": "migrateVolume", "params": [ { - "description": "destination storage pool ID to migrate the volume to", + "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, + "name": "newdiskofferingid", + "related": "", + "required": false, "type": "uuid" }, { @@ -85274,43 +85595,43 @@ "required": true, "type": "uuid" }, - { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", - "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "Hypervisor the volume belongs to", @@ -85318,90 +85639,84 @@ "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of 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 device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "true if the volume is extractable, false otherwise", @@ -85409,176 +85724,114 @@ "type": "boolean" }, { - "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 bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "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", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "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 project name of the vpn", - "name": "project", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { @@ -85587,28 +85840,33 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -85617,23 +85875,23 @@ "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { @@ -85641,77 +85899,86 @@ "name": "domain", "type": "string" }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "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": "shared or local storage", - "name": "storagetype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" - } - ], - "related": "configureHAForHost,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 ID of the host", - "name": "hostid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, {}, @@ -85721,36 +85988,28 @@ "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, - {}, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" } ], - "since": "4.11" + "since": "3.0.0" }, { "description": "A command to list events.", "isasync": false, "name": "listEvents", "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "the ID of the resource associated with the event", "length": 255, @@ -85760,42 +86019,40 @@ "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": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the duration of the event", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "duration", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the event", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listEvents", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the time the event was entered", "length": 255, - "name": "listall", + "name": "entrytime", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the event", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "id", - "related": "listEvents", + "name": "level", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", @@ -85805,34 +86062,49 @@ "required": false, "type": "uuid" }, + { + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "level", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the time the event was entered", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "entrytime", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the type of the resource associated with the event", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "since": "4.17.0", - "type": "string" + "type": "boolean" }, { "description": "the 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\")", @@ -85842,51 +86114,60 @@ "type": "date" }, { - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the event type (see event types)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "type", + "name": "account", "required": false, "type": "string" }, { - "description": "the duration of the event", + "description": "the type of the resource associated with the event", "length": 255, - "name": "duration", + "name": "resourcetype", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "string" }, { - "description": "List by keyword", + "description": "the event type (see event types)", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" } ], "related": "", "response": [ + { + "description": "the type of the resource", + "name": "resourcetype", + "type": "string" + }, + { + "description": "a brief description of the event", + "name": "description", + "type": "string" + }, + { + "description": "the id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "whether the event is parented", "name": "parentid", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the ID of the event", + "name": "id", "type": "string" }, { @@ -85894,10 +86175,9 @@ "name": "level", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { @@ -85906,71 +86186,57 @@ "type": "integer" }, { - "description": "the id of the resource", - "name": "resourceid", - "type": "string" - }, - {}, - { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the project id of the ipaddress", + "name": "projectid", "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 name of the resource", + "name": "resourcename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the account's domain", + "name": "domainid", "type": "string" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" - }, - { - "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 name of the account's domain", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, + {}, { - "description": "the ID of the event", - "name": "id", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", - "type": "string" + "description": "the state of the event", + "name": "state", + "type": "state" }, - { - "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" - } + {} ] }, { @@ -85979,12 +86245,12 @@ "name": "updateVMAffinityGroup", "params": [ { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "The ID of the virtual machine", "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", @@ -85995,29 +86261,89 @@ "type": "list" }, { - "description": "The ID of the virtual machine", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" } ], "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -86026,19 +86352,29 @@ "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -86046,29 +86382,34 @@ "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -86079,43 +86420,43 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -86127,13 +86468,23 @@ "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -86141,8 +86492,8 @@ "name": "ingressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -86155,68 +86506,53 @@ "name": "ruleid", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -86228,8 +86564,18 @@ "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "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" }, { @@ -86241,13 +86587,18 @@ "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -86255,6 +86606,21 @@ "name": "virtualmachineids", "type": "set" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the account owning the security group", "name": "account", @@ -86264,33 +86630,63 @@ "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 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 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": "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -86298,14 +86694,19 @@ "name": "domain", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -86314,131 +86715,61 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "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", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -86447,18 +86778,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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" }, { @@ -86467,234 +86798,200 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 list of nics associated with vm", - "name": "nic", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + {}, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the 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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "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": "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "OS name of the vm", - "name": "osdisplayname", - "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -86703,44 +87000,38 @@ "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -86749,214 +87040,254 @@ "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "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" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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 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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "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": "the project name of the affinity group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 ID of the affinity group", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" } ], "type": "set" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + } + ] + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "configureHAForHost,disableHAForHost", + "response": [ + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" } - ] + ], + "since": "4.11" }, { "description": "Registers NCC Service Package", @@ -86985,26 +87316,26 @@ "name": "description", "type": "string" }, - { - "description": "Service Package Name", - "name": "name", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Service Package UUID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Service Package Name", + "name": "name", + "type": "string" + }, + { + "description": "Service Package UUID", + "name": "id", "type": "string" } ] @@ -87015,11 +87346,11 @@ "name": "createTags", "params": [ { - "description": "list of resources to create the tags for", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "resourceids", + "name": "tags", "required": true, - "type": "list" + "type": "map" }, { "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", @@ -87036,20 +87367,14 @@ "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "list of resources to create the tags for", "length": 255, - "name": "tags", + "name": "resourceids", "required": true, - "type": "map" + "type": "list" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -87061,6 +87386,12 @@ "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", @@ -87074,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, @@ -87088,24 +87412,30 @@ "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 management IP address of the external firewall", - "name": "ipaddress", + "description": "the physical network to which this SRX firewall 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 usage interface of the external firewall", + "name": "usageinterface", + "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -87114,18 +87444,18 @@ "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "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" }, { @@ -87134,54 +87464,55 @@ "type": "long" }, { - "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": "device id of the SRX 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 private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "device state", + "name": "fwdevicestate", "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 usage interface of the external firewall", - "name": "usageinterface", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "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 username that's used to log in to the external firewall", - "name": "username", + "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": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" } ] @@ -87202,17 +87533,21 @@ ], "related": "configureInternalLoadBalancerElement", "response": [ - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the physical network service provider id of the element", "name": "nspid", @@ -87220,15 +87555,11 @@ }, {}, { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.2.0" }, @@ -87248,13 +87579,19 @@ "related": "", "response": [ { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "The client certificate", + "name": "certificate", "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 CA certificate(s)", + "name": "cacertificates", "type": "string" }, { @@ -87262,15 +87599,9 @@ "name": "privatekey", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -87292,16 +87623,17 @@ } ], "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -87312,8 +87644,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -87331,27 +87662,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": "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" } ] }, @@ -87361,18 +87692,18 @@ "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the id of the direct download certificate to provision", + "description": "the host to provision the certificate", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" }, { - "description": "the host to provision the certificate", + "description": "the id of the direct download certificate to provision", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate", "required": true, "type": "uuid" } @@ -87380,35 +87711,35 @@ "related": "", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the name of the host", + "name": "hostname", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, - {}, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" } ], @@ -87420,19 +87751,11 @@ "name": "generateAlert", "params": [ { - "description": "Zone id for which alert is generated", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "Name of the alert", + "description": "Type of the alert", "length": 255, - "name": "name", + "name": "type", "required": true, - "type": "string" + "type": "short" }, { "description": "Pod id for which alert is generated", @@ -87442,6 +87765,14 @@ "required": false, "type": "uuid" }, + { + "description": "Zone id for which alert is generated", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, { "description": "Alert description", "length": 999, @@ -87450,11 +87781,11 @@ "type": "string" }, { - "description": "Type of the alert", + "description": "Name of the alert", "length": 255, - "name": "type", + "name": "name", "required": true, - "type": "short" + "type": "string" } ], "response": [ @@ -87469,16 +87800,16 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.3" @@ -87496,18 +87827,18 @@ "type": "string" }, { - "description": "ID of the Project role", + "description": "ID of project where role is being created", "length": 255, - "name": "id", - "related": "updateProjectRole", + "name": "projectid", + "related": "activateProject,suspendProject", "required": true, "type": "uuid" }, { - "description": "ID of project where role is being created", + "description": "ID of the Project role", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "id", + "related": "updateProjectRole", "required": true, "type": "uuid" }, @@ -87522,19 +87853,18 @@ "related": "", "response": [ { - "description": "the ID of the role", - "name": "id", + "description": "the id of the project", + "name": "projectid", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -87548,9 +87878,10 @@ "type": "integer" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", "type": "string" } ], @@ -87561,13 +87892,6 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "linked domain", "length": 255, @@ -87576,6 +87900,13 @@ "required": false, "type": "uuid" }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "Port", "length": 255, @@ -87586,23 +87917,11 @@ ], "related": "", "response": [ - {}, - {}, - { - "description": "linked domain", - "name": "domainid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, { "description": "name of the host running the ldap server", "name": "hostname", @@ -87612,7 +87931,19 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + { + "description": "linked domain", + "name": "domainid", + "type": "string" + }, + { + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" + }, + {} ], "since": "4.2.0" }, @@ -87621,20 +87952,6 @@ "isasync": false, "name": "ldapConfig", "params": [ - { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", - "length": 255, - "name": "ssl", - "required": false, - "type": "boolean" - }, - { - "description": "Specify the LDAP port if required, default is 389.", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, { "description": "Enter the path to trust certificates store.", "length": 255, @@ -87650,11 +87967,11 @@ "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "hostname", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Enter the password for trust store.", @@ -87671,11 +87988,11 @@ "type": "boolean" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "queryfilter", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { "description": "Specify the distinguished name of a user with the search permission on the directory.", @@ -87690,29 +88007,42 @@ "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": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "DN password", + "name": "bindpass", "type": "string" }, { @@ -87721,24 +88051,25 @@ "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": "DN password", - "name": "bindpass", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, + {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" } ], @@ -87765,32 +88096,32 @@ "name": "jobid", "type": "string" }, + { + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" + }, {}, { "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, + { + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "type": "string" - }, { "description": "the ID of the Storage Policy", "name": "id", "type": "string" }, - { - "description": "the description of the Storage Policy", - "name": "description", - "type": "string" - }, {}, { "description": "the name of the Storage Policy", @@ -87814,27 +88145,27 @@ } ], "response": [ - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -87844,18 +88175,18 @@ "name": "migrateVPC", "params": [ { - "description": "vpc offering ID", + "description": "the ID of the vpc", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" }, { - "description": "the ID of the vpc", + "description": "vpc offering ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": true, "type": "uuid" }, @@ -87877,39 +88208,8 @@ "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "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 name of the zone the VPC belongs to", - "name": "zonename", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { @@ -87918,45 +88218,45 @@ "type": "boolean" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "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": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { "description": "vpc offering id the VPC is created from", @@ -87964,52 +88264,109 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the provider name", - "name": "name", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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": "true if individual services can be enabled/disabled", @@ -88017,28 +88374,18 @@ "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", @@ -88065,65 +88412,23 @@ "type": "list" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", "type": "list" }, { @@ -88131,20 +88436,46 @@ "name": "project", "type": "string" }, + {}, { - "description": "the id of the VPC", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "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" @@ -88164,28 +88495,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" + } ] }, { @@ -88194,27 +88525,49 @@ "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 contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "the (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", + "type": "string" + }, { "description": "the name of the entitiy to which this annotation pertains", "name": "entityname", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the creation timestamp for this annotation", "name": "created", @@ -88226,13 +88579,8 @@ "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { @@ -88246,31 +88594,14 @@ "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - {}, - { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" - }, - {}, - { - "description": "the current status of the latest 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 of the user that entered the annotation", + "name": "username", "type": "string" }, { - "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" } ], "since": "4.16" @@ -88288,41 +88619,51 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "bigswitch BCF controller device ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "bigswitch BCF controller device ID", + "description": "the Physical Network ID", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller username", + "name": "username", + "type": "string" + }, + { + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "type": "string" + }, + { + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -88335,69 +88676,17 @@ "name": "jobid", "type": "string" }, - { - "description": "the controller username", - "name": "username", - "type": "string" - }, { "description": "NAT support", "name": "nat", "type": "boolean" }, + {}, { "description": "name of the provider", "name": "provider", "type": "string" }, - { - "description": "the controller password", - "name": "password", - "type": "string" - }, - { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - }, - {} - ], - "since": "4.6.0" - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - }, - { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - } - ], - "related": "disableHAForHost", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -88405,38 +88694,17 @@ }, {}, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {}, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" } ], - "since": "4.11" + "since": "4.6.0" }, { "description": "Updates a configuration.", @@ -88451,10 +88719,10 @@ "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" }, @@ -88467,26 +88735,25 @@ "type": "uuid" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "imagestoreuuid", + "related": "listSwifts,addImageStoreS3,listImageStores", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", + "description": "the value of the configuration", + "length": 4096, + "name": "value", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, @@ -88499,24 +88766,24 @@ "type": "uuid" }, { - "description": "the value of the configuration", - "length": 4095, - "name": "value", + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { @@ -88524,38 +88791,102 @@ "name": "scope", "type": "string" }, - {}, + { + "description": "the description of the configuration", + "name": "description", + "type": "string" + }, { "description": "the value of the configuration", "name": "value", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 value of the configuration", + "name": "id", + "type": "long" + } + ] + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "HA provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "disableHAForHost", + "response": [ + {}, + {}, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the 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": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11" }, { "description": "Dedicates a Public IP range to an account", @@ -88570,6 +88901,13 @@ "required": true, "type": "uuid" }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "domain ID of the account owning a VLAN", "length": 255, @@ -88585,50 +88923,38 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -88637,95 +88963,100 @@ "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, + {}, { "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 Zone ID of the VLAN IP range", "name": "zoneid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "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 account of the VLAN IP range", - "name": "account", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" } ] @@ -88735,13 +89066,6 @@ "isasync": false, "name": "createProjectRolePermission", "params": [ - { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "ID of project where project role permission is to be created", "length": 255, @@ -88751,10 +89075,10 @@ "type": "uuid" }, { - "description": "The API name or wildcard rule such as list*", + "description": "The description of the role permission", "length": 255, - "name": "rule", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -88764,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, @@ -88775,20 +89106,14 @@ ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the ID of the project", - "name": "projectid", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { @@ -88802,24 +89127,30 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, {}, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "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 permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -88859,11 +89190,9 @@ "name": "name", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { @@ -88872,15 +89201,17 @@ "type": "integer" }, { - "description": "Service Package UUID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", + "description": "Service Package UUID", + "name": "id", "type": "string" - } + }, + {}, + {} ] }, { @@ -88888,14 +89219,6 @@ "isasync": false, "name": "updateProjectRolePermission", "params": [ - { - "description": "ID of project where project role permission is to be updated", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, { "description": "ID of the project role", "length": 255, @@ -88912,28 +89235,37 @@ "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Project Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "projectrolepermissionid", "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Project Role permission rule id", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "projectrolepermissionid", + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" + }, + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", "related": "", "required": false, - "type": "uuid" + "type": "list" } ], "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", @@ -88941,16 +89273,15 @@ }, {}, { - "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.15.0" }, @@ -88960,44 +89291,38 @@ "name": "enableStaticNat", "params": [ { - "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", + "description": "VM guest NIC secondary IP address for the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "vmguestip", "required": false, - "type": "uuid" + "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" }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", "length": 255, - "name": "vmguestip", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -89009,6 +89334,12 @@ "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", @@ -89031,27 +89362,27 @@ } ], "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "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" } ] }, @@ -89067,6 +89398,13 @@ "required": false, "type": "string" }, + { + "description": "Name of the user to be added to the project", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "ID of the project to add the user to", "length": 255, @@ -89089,37 +89427,30 @@ "name": "roletype", "required": false, "type": "string" - }, - { - "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": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.14" @@ -89144,23 +89475,23 @@ "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "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" }, @@ -89181,44 +89512,15 @@ "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 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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + {}, { - "description": "the ID of the 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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "the ID of the backup offering of the virtual machine", @@ -89226,308 +89528,226 @@ "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", - "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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ssh key-pairs", + "name": "keypairs", "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 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": "OS type id of the vm", - "name": "ostypeid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, - {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the description of the affinity 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 affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ + }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], "type": "set" }, { - "description": "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 id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -89539,8 +89759,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" }, { @@ -89549,156 +89769,126 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "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" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ + }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the list of 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", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -89707,13 +89897,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -89722,17 +89912,27 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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", @@ -89740,89 +89940,134 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the 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", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "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" } ], "type": "set" @@ -89833,33 +90078,33 @@ "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -89868,8 +90113,34 @@ "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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" }, { @@ -89878,77 +90149,134 @@ "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the 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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -89962,18 +90290,33 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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" }, { @@ -89982,13 +90325,18 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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" }, { @@ -89997,9 +90345,14 @@ "type": "list" }, { - "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "IP addresses associated with NIC found for unmanaged VM", @@ -90007,67 +90360,51 @@ "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -90076,60 +90413,64 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" } ] }, @@ -90139,19 +90480,34 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "isextractable", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", "length": 255, - "name": "sshkeyenabled", + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, "type": "boolean" }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, { "description": "Upload volume/template for the project", "length": 255, @@ -90161,10 +90517,10 @@ "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { @@ -90183,52 +90539,30 @@ "type": "map" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "deployasis", + "name": "isrouting", "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": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "isdynamicallyscalable", + "name": "account", "required": false, - "type": "boolean" - }, - { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "isrouting", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isfeatured", + "name": "ispublic", "required": false, "type": "boolean" }, @@ -90240,9 +90574,17 @@ "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "passwordenabled", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "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" }, @@ -90254,26 +90596,33 @@ "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "ispublic", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the tag for this template.", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "templatetag", + "name": "deployasis", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { "description": "true if this template requires HVM", @@ -90283,60 +90632,52 @@ "type": "boolean" }, { - "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": "32 or 64 bits support. 64 by default", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "bits", + "name": "sshkeyenabled", "required": false, - "type": "integer" + "type": "boolean" } ], "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": "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": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, + {}, { "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 template/volume ID", - "name": "id", - "type": "uuid" - } + {} ], "since": "4.6.0" }, @@ -90355,27 +90696,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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.17.0" @@ -90395,26 +90736,26 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -90424,6 +90765,13 @@ "isasync": true, "name": "updateProjectInvitation", "params": [ + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "id of the project to join", "length": 255, @@ -90447,13 +90795,6 @@ "required": false, "type": "string" }, - { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "if true, accept the invitation, decline if false. True by default", "length": 255, @@ -90468,18 +90809,18 @@ "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", @@ -90504,19 +90845,29 @@ ], "related": "", "response": [ + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, { "description": "type of the disk volume", "name": "volumetype", "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": "name of the disk volume", - "name": "volumename", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { @@ -90524,24 +90875,55 @@ "name": "volumeid", "type": "string" }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, { "description": "ID of the snapshot", "name": "id", "type": "string" }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "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 type of the snapshot", + "name": "snapshottype", "type": "string" }, { @@ -90550,22 +90932,33 @@ "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, + {}, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -90574,8 +90967,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -90584,18 +90977,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -90604,16 +90997,21 @@ "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": "id of the availability zone", - "name": "zoneid", + "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" }, { @@ -90622,66 +91020,9 @@ "type": "date" }, { - "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": "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": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" } ] }, @@ -90691,11 +91032,11 @@ "name": "listRegions", "params": [ { - "description": "List Region by region name.", + "description": "List Region by region ID.", "length": 255, - "name": "name", + "name": "id", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -90707,132 +91048,71 @@ { "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" }, { - "description": "", + "description": "List Region by region name.", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" } ], "related": "addRegion", "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 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 ID of the region", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ID of the region", + "name": "id", "type": "integer" }, { "description": "the name of the region", "name": "name", "type": "string" - } - ] - }, - { - "description": "Configures an Internal Load Balancer element.", - "isasync": true, - "name": "configureInternalLoadBalancerElement", - "params": [ - { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, - { - "description": "the ID of the internal lb provider", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, + {}, + {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "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 physical network service provider id of the element", - "name": "nspid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, - {}, - {} - ], - "since": "4.2.0" + } + ] }, { "description": "Attempts Migration of a system virtual machine to the host specified.", "isasync": true, "name": "migrateSystemVm", "params": [ - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", - "required": true, - "type": "uuid" - }, { "description": "destination Host ID to migrate VM to", "length": 255, @@ -90850,6 +91130,14 @@ "since": "4.16.0", "type": "uuid" }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateSystemVm", + "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, @@ -90862,83 +91150,74 @@ "related": "", "response": [ { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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" }, { @@ -90947,24 +91226,19 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -90973,80 +91247,84 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, - {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "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 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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", @@ -91054,8 +91332,18 @@ "type": "boolean" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "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 state of the system VM", + "name": "state", "type": "string" } ] @@ -91072,13 +91360,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "Source of the counter.", "length": 255, @@ -91094,6 +91375,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -91111,44 +91399,97 @@ ], "related": "createCounter", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "Source of the counter.", "name": "source", "type": "string" }, - {}, { "description": "the id of the Counter", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "zone id of counter", "name": "zoneid", "type": "string" }, + { + "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": "Name of the counter.", "name": "name", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", + "params": [ { - "description": "Value in case of snmp or other specific counters.", - "name": "value", - "type": "string" + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + }, + { + "description": "the ID of the internal lb provider", + "length": 255, + "name": "id", + "related": "configureInternalLoadBalancerElement", + "required": true, + "type": "uuid" } - ] + ], + "related": "", + "response": [ + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.2.0" }, { "description": "Lists all available virtual router elements.", @@ -91162,13 +91503,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list virtual router elements by network service provider id", "length": 255, @@ -91192,6 +91526,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -91203,17 +91544,10 @@ "related": "", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the project id of the ipaddress", "name": "projectid", @@ -91224,34 +91558,41 @@ "name": "domain", "type": "string" }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "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" } ] @@ -91279,17 +91620,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", @@ -91300,6 +91630,17 @@ "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" + }, + {}, {} ] }, @@ -91316,11 +91657,11 @@ "type": "string" }, { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "description": "", "length": 255, - "name": "traffictype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -91330,36 +91671,36 @@ "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": "pagesize", + "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": "network traffic type", - "name": "traffictype", - "type": "string" - }, + {}, {}, { "description": "implementor of network traffic type", "name": "traffictypeimplementor", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "network traffic type", + "name": "traffictype", + "type": "string" } ], "since": "3.0.0" @@ -91370,32 +91711,32 @@ "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": "integer" + "type": "string" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" }, { - "description": "name of the account, it will be created if it does not exist", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", "length": 255, - "name": "account", - "required": true, + "name": "type", + "required": false, "type": "string" }, { @@ -91406,30 +91747,42 @@ "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "ldapdomain", + "name": "accounttype", "required": true, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + { + "description": "Domain Admin accountId that is created", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "name", "type": "string" }, + { + "description": "type of the name in LDAP which is linke to the domain", + "name": "type", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -91441,21 +91794,9 @@ "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" - }, - {}, - { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" - }, - {}, - { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", - "type": "string" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" } ], "since": "4.11.0" @@ -91467,67 +91808,67 @@ "params": [], "related": "", "response": [ - {}, - { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, { "description": "the name of the active usage server", "name": "hostname", "type": "string" }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + {}, { "description": "the last measured load averages on the DB", "name": "dbloadaverages", "type": "double[]" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the version of the currently running DB", - "name": "version", - "type": "string" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "int" }, { - "description": "the number of connections to the DB", - "name": "connections", - "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 uptime of the DB in seconds", - "name": "uptime", - "type": "int" - }, - { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the number of queries performed on the DB", "name": "queries", "type": "int" }, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" + }, + { + "description": "the version of the currently running DB", + "name": "version", + "type": "string" + }, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" } ], "since": "4.17.0" @@ -91547,11 +91888,6 @@ } ], "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", @@ -91564,6 +91900,11 @@ "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", @@ -91578,59 +91919,59 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the templateid of the autoscale vm profile", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "listall", "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": "availability zone for the auto deployed virtual machine", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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 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": "the otherdeployparameters of the autoscale vm profile", @@ -91640,19 +91981,26 @@ "type": "string" }, { - "description": "the ID of the autoscale vm profile", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the templateid of the autoscale vm profile", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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.", @@ -91671,18 +92019,11 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "createAutoScaleVmProfile", @@ -91693,33 +92034,29 @@ "type": "integer" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "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 project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" - }, - { - "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 domain ID of the vm profile", - "name": "domainid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { @@ -91728,36 +92065,29 @@ "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, - {}, { - "description": "the project name of the vm profile", - "name": "project", + "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 account owning the instance group", - "name": "account", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "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" }, { @@ -91765,6 +92095,17 @@ "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 account owning the instance group", + "name": "account", + "type": "string" + }, + {}, {} ] }, @@ -91784,73 +92125,73 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the ID of the host", - "name": "hostid", + "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 description", - "name": "description", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the operation result", "name": "status", "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "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" }, @@ -91870,169 +92211,119 @@ ], "related": "addBaremetalHost,reconnectHost", "response": [ - {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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", + "type": "long" }, { - "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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the 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 total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "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" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "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": "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 host type", - "name": "type", - "type": "type" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "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 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 host version", - "name": "version", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -92041,158 +92332,194 @@ "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "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 speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "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 cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the name of the host", - "name": "name", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "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 amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "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 no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the resource state of the host", + "name": "resourcestate", + "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 admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -92200,36 +92527,50 @@ "name": "hostha", "type": "hostharesponse" }, - {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "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": "the management server ID of the host", - "name": "managementserverid", + "description": "the host version", + "name": "version", "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 OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" } ], "since": "4.16.0.0" @@ -92240,32 +92581,34 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "error code for this icmp message", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "icmpcode", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "user to security group mapping", + "description": "error code for this icmp message", "length": 255, - "name": "usersecuritygrouplist", + "name": "icmpcode", "required": false, - "type": "map" + "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": "end port for this ingress rule", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "endport", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", @@ -92275,84 +92618,97 @@ "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "start port for this ingress rule", "length": 255, - "name": "account", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "user to security group mapping", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "usersecuritygrouplist", "required": false, - "type": "uuid" + "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 protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "start port for this ingress rule", + "description": "type of the icmp message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "an optional project of the security group", "length": 255, - "name": "icmptype", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", @@ -92373,44 +92729,39 @@ "name": "project", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, {}, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, {}, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -92418,29 +92769,19 @@ "name": "startport", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ] @@ -92462,23 +92803,39 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the 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": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -92487,9 +92844,9 @@ "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 date and time the storage pool was created", @@ -92497,64 +92854,68 @@ "type": "date" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", + "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 cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, - {}, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -92562,47 +92923,27 @@ "name": "hypervisor", "type": "string" }, - {}, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - } + {} ], "since": "4.15.1" }, @@ -92619,19 +92960,11 @@ "type": "string" }, { - "description": "name of the security group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Create security group for project", + "description": "the description of the security group", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", @@ -92642,86 +92975,31 @@ "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" + }, + { + "description": "Create security group for project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -92729,53 +93007,34 @@ "name": "project", "type": "string" }, + {}, { - "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", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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" }, { @@ -92783,13 +93042,13 @@ "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": "tag key name", + "name": "key", "type": "string" }, { @@ -92798,13 +93057,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -92813,57 +93072,56 @@ "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 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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - {}, { "description": "the domain ID of the security group", "name": "domainid", @@ -92874,23 +93132,8 @@ "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -92903,23 +93146,33 @@ "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": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -92928,8 +93181,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -92938,13 +93191,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -92953,40 +93206,128 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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 ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "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 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 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 description of the security group", "name": "description", "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -93006,36 +93347,26 @@ ], "related": "", "response": [ - { - "description": "the project the network is available for", - "name": "project", - "type": "string" - }, { "description": "the network ID", "name": "networkid", "type": "string" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "the account the network is available for", + "name": "account", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, { @@ -93044,13 +93375,23 @@ "type": "string" }, { - "description": "the account the network is available for", - "name": "account", + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "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" } ], @@ -93069,13 +93410,6 @@ "required": false, "type": "uuid" }, - { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" - }, { "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, @@ -93090,20 +93424,20 @@ "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" + }, + { + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the project name for which resource count's are updated", - "name": "project", - "type": "string" - }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { @@ -93112,39 +93446,46 @@ "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", - "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", + "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", "type": "integer" }, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "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 account for which resource count's are updated", - "name": "account", + "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": "resource count", - "name": "resourcecount", - "type": "long" + "description": "the project id for which resource count's are updated", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID for which resource count's are updated", + "name": "domainid", + "type": "string" } ] }, @@ -93154,20 +93495,28 @@ "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": "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": "id of the vpn gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -93184,110 +93533,102 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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 objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "id of the vpn 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": "createVpnGateway,listVpnGateways", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "id of vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVpnGateway", "response": [ { - "description": "the project id", - "name": "projectid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, {}, + {}, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the 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 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": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { @@ -93296,14 +93637,14 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the UUID of the latest async job acting on 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 vpn gateway ID", + "name": "id", + "type": "string" } ] }, @@ -93312,6 +93653,20 @@ "isasync": false, "name": "listRoles", "params": [ + { + "description": "List role by role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, @@ -93334,20 +93689,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "List role by role name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -93359,40 +93700,40 @@ "related": "importRole", "response": [ { - "description": "the description of the role", - "name": "description", + "description": "the type of the role", + "name": "type", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the type of the role", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the name of the role", - "name": "name", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the role", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the role", + "name": "description", "type": "string" } ], @@ -93415,32 +93756,32 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 cloud identifier", - "name": "cloudidentifier", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -93448,6 +93789,21 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the description of the load balancer stickiness policy", "length": 255, @@ -93470,21 +93826,6 @@ "required": true, "type": "uuid" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, @@ -93496,8 +93837,13 @@ "related": "listLBStickinessPolicies", "response": [ { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", "type": "string" }, {}, @@ -93507,23 +93853,39 @@ "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the method name of the Stickiness policy", "name": "methodname", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { "description": "the name of the Stickiness policy", @@ -93531,14 +93893,9 @@ "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { "description": "the LB Stickiness policy ID", @@ -93554,23 +93911,13 @@ "type": "list" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { @@ -93579,16 +93926,10 @@ "type": "integer" }, { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -93597,14 +93938,6 @@ "isasync": false, "name": "addCiscoAsa1000vResource", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "the Cluster ID", "length": 255, @@ -93620,6 +93953,14 @@ "required": true, "type": "string" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, @@ -93630,7 +93971,6 @@ ], "related": "", "response": [ - {}, {}, {}, { @@ -93638,7 +93978,6 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -93646,6 +93985,8 @@ }, {}, {}, + {}, + {}, {} ] }, @@ -93672,34 +94013,24 @@ ], "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "response": [ - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { @@ -93707,24 +94038,26 @@ "name": "publicinterface", "type": "string" }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, { "description": "the private security zone of the external firewall", "name": "privatezone", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "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" }, { @@ -93733,13 +94066,18 @@ "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { @@ -93748,22 +94086,25 @@ "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, - {}, - {} + { + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" + } ] }, { @@ -93772,33 +94113,47 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "the starting port of ACL", + "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": "startport", + "name": "partialupgrade", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "partialupgrade", + "name": "number", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "reason", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the network ACL item", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" + }, + { + "description": "the starting port of ACL", + "length": 255, + "name": "startport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" + }, + { + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "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", @@ -93816,26 +94171,26 @@ "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "scl entry action, allow or deny", "length": 255, - "name": "protocol", + "name": "action", "required": false, "type": "string" }, { - "description": "the ID of the network ACL item", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "error code for this ICMP message", @@ -93845,11 +94200,11 @@ "type": "integer" }, { - "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 ending port of ACL", @@ -93857,61 +94212,119 @@ "name": "endport", "required": false, "type": "integer" + } + ], + "related": "moveNetworkAclItem", + "response": [ + {}, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", - "length": 255, + "description": "Number of the ACL Item", "name": "number", - "required": false, "type": "integer" }, { - "description": "scl entry action, allow or deny", - "length": 255, + "description": "Action of ACL Item. Allow/Deny", "name": "action", - "required": false, "type": "string" - } - ], - "related": "moveNetworkAclItem", - "response": [ + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -93920,104 +94333,32 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, - {}, - { - "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", - "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": "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": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - {}, { "description": "type of the icmp message being sent", "name": "icmptype", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" } ] }, @@ -94026,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, @@ -94040,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": "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.11" @@ -94082,19 +94423,35 @@ "name": "listRouters", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the disk router", "length": 255, - "name": "listall", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "List by keyword", "length": 255, - "name": "healthchecksfailed", + "name": "keyword", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { "description": "", @@ -94104,25 +94461,25 @@ "type": "integer" }, { - "description": "List networks by VPC", + "description": "the state of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "the Pod ID of the router", "length": 255, - "name": "forvpc", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk router", + "description": "the cluster ID of the router", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, @@ -94135,35 +94492,28 @@ "type": "uuid" }, { - "description": "the name of the router", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "list by network id", + "description": "the host ID of the router", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List networks by VPC", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "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 virtual router elements by version", "length": 255, @@ -94172,84 +94522,70 @@ "type": "string" }, { - "description": "the Zone ID of the router", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the state of the router", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default 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": "fetchhealthcheckresults", + "name": "listall", "required": false, - "since": "4.14", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "isrecursive", + "name": "forvpc", "required": false, "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": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Pod ID of the router", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "healthchecksfailed", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "the cluster ID of the router", + "description": "the name of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the host ID of the router", + "description": "", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "destroyRouter", "response": [ { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -94257,35 +94593,34 @@ "name": "hostid", "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -94298,33 +94633,33 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the 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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -94333,19 +94668,29 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { "description": "the IPv6 address of network", @@ -94353,28 +94698,28 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -94383,66 +94728,86 @@ "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 ID of the corresponding network", - "name": "networkid", - "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { "description": "the isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -94451,78 +94816,80 @@ "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "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 version of scripts", + "name": "scriptsversion", + "type": "string" }, + {}, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, + {}, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "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 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 project id of the ipaddress", - "name": "projectid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -94531,24 +94898,39 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { "description": "the link local netmask for the router", @@ -94556,18 +94938,33 @@ "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { @@ -94575,9 +94972,9 @@ "name": "healthcheckresults", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { "description": "detailed response generated on running health check", @@ -94585,9 +94982,9 @@ "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { "description": "the type of the health check - basic or advanced", @@ -94595,72 +94992,21 @@ "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" } ], "type": "list" }, { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - {}, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "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 domain associated with the router", - "name": "domain", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -94669,8 +95015,13 @@ "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" } ] @@ -94690,6 +95041,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": "any text associated with the success or failure", @@ -94701,16 +95062,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", - "type": "boolean" - }, {} ] }, @@ -94719,13 +95070,6 @@ "isasync": true, "name": "createVpnConnection", "params": [ - { - "description": "connection is passive or not", - "length": 255, - "name": "passive", - "required": false, - "type": "boolean" - }, { "description": "id of the customer gateway", "length": 255, @@ -94734,6 +95078,13 @@ "required": true, "type": "uuid" }, + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" + }, { "description": "id of the vpn gateway", "length": 255, @@ -94754,28 +95105,13 @@ "related": "", "response": [ { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { @@ -94783,32 +95119,35 @@ "name": "ikepolicy", "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": "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": "the owner", - "name": "account", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, - {}, - {}, { - "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -94816,50 +95155,62 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the connection ID", + "name": "id", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, + {}, { "description": "IPsec Preshared-Key of the customer gateway", "name": "ipsecpsk", @@ -94876,18 +95227,18 @@ "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the public IP address", + "name": "publicip", "type": "string" } ] @@ -94897,21 +95248,6 @@ "isasync": false, "name": "listBrocadeVcsDeviceNetworks", "params": [ - { - "description": "brocade vcs switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -94925,58 +95261,68 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The external id of the network", + "name": "externalid", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { @@ -94985,8 +95331,13 @@ "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -94995,215 +95346,204 @@ "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", - "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", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "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": "the traffic type of the network", "name": "traffictype", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "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": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "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": "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 network", - "name": "state", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the project name of the address", + "name": "project", "type": "string" }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, { "description": "true if network is system, false otherwise", "name": "issystem", "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "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": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { @@ -95211,8 +95551,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -95221,23 +95566,23 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -95246,153 +95591,159 @@ "type": "string" }, { - "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "the name of the 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" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" } ] }, @@ -95411,28 +95762,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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.0" }, @@ -95449,6 +95800,13 @@ "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 host to update", "length": 255, @@ -95456,41 +95814,35 @@ "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "listDedicatedHosts", "response": [ + {}, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the name of the host", - "name": "hostname", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -95499,16 +95851,15 @@ "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" - }, - {} + } ] }, { @@ -95517,11 +95868,12 @@ "name": "removeVpnUser", "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "remove vpn user from the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "username for the vpn user", @@ -95531,44 +95883,43 @@ "type": "string" }, { - "description": "remove vpn user from the project", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "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" + }, {} ] }, @@ -95578,23 +95929,16 @@ "name": "addGloboDnsHost", "params": [ { - "description": "GloboDNS url", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "Username for GloboDNS", + "description": "Password for GloboDNS", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Password for GloboDNS", + "description": "GloboDNS url", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, @@ -95605,31 +95949,38 @@ "related": "createPhysicalNetwork", "required": true, "type": "uuid" + }, + { + "description": "Username for GloboDNS", + "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": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.5.0" }, @@ -95640,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" - } + }, + {}, + {} ] }, { @@ -95674,28 +96025,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ], "since": "4.2.0" }, @@ -95705,18 +96056,11 @@ "name": "importRole", "params": [ { - "description": "The description of the role", + "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": "description", + "name": "forced", "required": false, - "type": "string" - }, - { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", - "length": 255, - "name": "rules", - "required": true, - "type": "map" + "type": "boolean" }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", @@ -95726,11 +96070,11 @@ "type": "string" }, { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "description": "The description of the role", "length": 255, - "name": "forced", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Creates a role with this unique name", @@ -95738,86 +96082,37 @@ "name": "name", "required": true, "type": "string" - } - ], - "related": "", - "response": [ - { - "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 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 type of the role", - "name": "type", - "type": "string" }, - {}, - { - "description": "the ID of the role", - "name": "id", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ { - "description": "ID of the host", + "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": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "rules", "required": true, - "type": "uuid" + "type": "map" } ], "related": "", "response": [ {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "the description of the role", + "name": "description", + "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 host HA provider", - "name": "haprovider", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -95826,17 +96121,17 @@ "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the name of the role", + "name": "name", + "type": "string" } ], - "since": "4.11" + "since": "4.15.0" }, { "description": "List Swift.", @@ -95846,14 +96141,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -95874,80 +96169,136 @@ ], "related": "addImageStoreS3,listImageStores", "response": [ + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + {}, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, + } + ], + "since": "3.0.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ { - "description": "the provider name of the image store", - "name": "providername", + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if host HA is enabled for the host", + "name": "haenable", "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], - "since": "3.0.0" + "since": "4.11" }, { "description": "Enables out-of-band management for a host", @@ -95965,7 +96316,11 @@ ], "related": "disableOutOfBandManagementForCluster", "response": [ - {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, { "description": "the operation result", "name": "status", @@ -95973,28 +96328,28 @@ }, {}, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -96003,34 +96358,30 @@ "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", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, + {}, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" } ], "since": "4.9.0" @@ -96056,21 +96407,21 @@ "type": "boolean" }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -96079,13 +96430,6 @@ "isasync": false, "name": "listKubernetesSupportedVersions", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, @@ -96094,20 +96438,18 @@ "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "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": "", @@ -96116,6 +96458,14 @@ "required": false, "type": "integer" }, + { + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" + }, { "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, @@ -96125,51 +96475,50 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "keyword", + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, { "description": "the id of the Kubernetes supported version", "name": "id", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { "description": "the id of the binaries ISO for Kubernetes supported version", @@ -96177,39 +96526,46 @@ "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 id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, + { + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + {}, { "description": "whether Kubernetes supported version supports HA, multi-control nodes", "name": "supportsha", "type": "boolean" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" - }, - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "Kubernetes semantic version", + "name": "semanticversion", "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": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" } ] }, @@ -96219,17 +96575,17 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "hostname", - "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" }, { @@ -96246,6 +96602,13 @@ "required": true, "type": "string" }, + { + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l2gatewayserviceuuid", + "required": false, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -96255,40 +96618,40 @@ "type": "uuid" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, - "type": "string" - }, - { - "description": "Credentials to access the Nicira Controller API", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "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 transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, + {}, { "description": "the physical network to which this Nirica Nvp belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { @@ -96297,14 +96660,14 @@ "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "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", @@ -96312,17 +96675,10 @@ "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", + "description": "the controller Ip address", + "name": "hostname", "type": "string" - }, - {}, - {} + } ] }, { @@ -96331,38 +96687,38 @@ "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": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "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": "list providers by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list providers by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -96377,15 +96733,9 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the provider name", @@ -96393,23 +96743,23 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -96417,12 +96767,18 @@ "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + {}, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } ], "since": "3.0.0" }, @@ -96434,75 +96790,75 @@ "related": "", "response": [ { - "description": "Number of pods", - "name": "pods", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of management servers", + "name": "managementservers", + "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of pods", + "name": "pods", "type": "integer" }, {}, { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of routers", + "name": "routers", "type": "integer" }, - {}, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" } ], @@ -96514,18 +96870,25 @@ "name": "listUsageRecords", "params": [ { - "description": "", + "description": "List usage records for the specified usage type", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "long" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "length": 255, + "name": "oldformat", + "required": false, + "type": "boolean" }, { "description": "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).", @@ -96535,38 +96898,39 @@ "type": "date" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "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": "usageid", + "name": "isrecursive", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "List usage records for the specified usage type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "List usage records for the specified account", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "includetags", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "List usage records for specified project", "length": 255, - "name": "includetags", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "keyword", + "name": "usageid", "required": false, "type": "string" }, @@ -96579,19 +96943,11 @@ "type": "uuid" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", - "length": 255, - "name": "oldformat", - "required": false, - "type": "boolean" - }, - { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "since": "4.15", - "type": "boolean" + "type": "integer" }, { "description": "List usage records for the specified user.", @@ -96600,159 +96956,148 @@ "required": false, "type": "string" }, - { - "description": "List usage records for specified project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, { "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", "length": 255, "name": "startdate", "required": true, "type": "date" + }, + { + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain the resource is associated with", - "name": "domain", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, + { + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "start date of the usage record", - "name": "startdate", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "template ID", - "name": "templateid", - "type": "string" + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" }, { - "description": "id of the resource", - "name": "usageid", + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "the user account Id", - "name": "accountid", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", - "type": "string" + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the project id of the resource", - "name": "projectid", + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "resource size", + "name": "size", + "type": "long" + }, + { + "description": "the user account Id", + "name": "accountid", "type": "string" }, - {}, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "the domain ID", - "name": "domainid", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" + "description": "offering ID", + "name": "offeringid", + "type": "string" }, { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" }, { "description": "the project name of the resource", "name": "project", "type": "string" }, - { - "description": "offering ID", - "name": "offeringid", - "type": "string" - }, { "description": "usage type ID", "name": "usagetype", "type": "integer" }, - { - "description": "resource size", - "name": "size", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "resource type", - "name": "type", + "description": "end date of the usage record", + "name": "enddate", "type": "string" }, { - "description": "description of the usage record", - "name": "description", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { - "description": "id of the network", - "name": "networkid", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", + "description": "True if the resource is default", + "name": "isdefault", "type": "boolean" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - {}, - { - "description": "the user account name", - "name": "account", - "type": "string" - }, - { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "virtual machine os display name", - "name": "osdisplayname", + "description": "virtual machine ID", + "name": "virtualmachineid", "type": "string" }, { @@ -96760,8 +97105,8 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -96775,86 +97120,97 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "resource type", + "name": "type", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, + { + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" + "description": "the zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "description of the usage record", + "name": "description", "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" + "description": "template ID", + "name": "templateid", + "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", + "description": "start date of the usage record", + "name": "startdate", "type": "string" } ] @@ -96874,18 +97230,18 @@ } ], "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -96914,19 +97270,14 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest 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" }, { @@ -96934,6 +97285,11 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -96954,48 +97310,43 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -97004,90 +97355,53 @@ "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "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", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -97096,63 +97410,64 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the path of the volume", + "name": "path", "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" }, { @@ -97160,36 +97475,14 @@ "name": "diskofferingname", "type": "string" }, - {}, - {}, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { @@ -97198,149 +97491,212 @@ "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "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": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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" @@ -97361,19 +97717,30 @@ ], "related": "createUser,getUser", "response": [ + {}, { - "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 account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "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 user ID", + "name": "id", "type": "string" }, { @@ -97382,35 +97749,23 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the user lastname", "name": "lastname", "type": "string" }, - {}, - { - "description": "the user state", - "name": "state", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -97419,29 +97774,24 @@ "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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 account ID of the user", + "name": "accountid", + "type": "string" }, { "description": "the name of the role", @@ -97449,40 +97799,46 @@ "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user name", - "name": "username", + "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 timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" - } + }, + {} ] }, { @@ -97498,14 +97854,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, { "description": "flag to display the resource image for the zones", "length": 255, @@ -97521,26 +97869,18 @@ "type": "boolean" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", - "length": 255, - "name": "available", - "required": false, - "type": "boolean" - }, - { - "description": "List zones by resource tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "map" + "type": "integer" }, { - "description": "", + "description": "the name of the zone", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -97556,6 +97896,21 @@ "required": false, "type": "string" }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "length": 255, + "name": "available", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -97564,29 +97919,25 @@ "type": "integer" }, { - "description": "the name of the zone", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "since": "4.3", + "type": "map" } ], "related": "", "response": [ { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { "description": "Zone id", @@ -97594,72 +97945,97 @@ "type": "string" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "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": "Zone name", + "name": "name", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -97668,77 +98044,77 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], "type": "list" }, + {}, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { @@ -97746,33 +98122,33 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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" }, { @@ -97781,61 +98157,56 @@ "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" } ], "type": "set" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "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": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { @@ -97844,23 +98215,29 @@ "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -97869,51 +98246,30 @@ "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, { "description": "cpu allocated disable threshold exceeded", "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "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", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" - }, - {} + } ], "since": "4.9.3" }, @@ -97923,12 +98279,18 @@ "name": "extractTemplate", "params": [ { - "description": "the ID of the zone where the ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" }, { "description": "the ID of the template", @@ -97939,56 +98301,45 @@ "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, - { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, + {}, { "description": "the id of extracted object", "name": "id", "type": "string" }, - { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the status of the extraction", + "name": "status", + "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" }, { @@ -97997,9 +98348,9 @@ "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", @@ -98007,34 +98358,39 @@ "type": "date" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "", - "name": "resultstring", + "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": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "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", + "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" } ] @@ -98054,28 +98410,28 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "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" - }, - {} + } ] }, { @@ -98095,68 +98451,114 @@ "related": "activateProject", "response": [ { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the state of the project", + "name": "state", "type": "string" }, - {}, { - "description": "the id of the project", - "name": "id", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -98165,28 +98567,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -98198,105 +98600,64 @@ "description": "the account associated with the tag", "name": "account", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "list" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "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", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total 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", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "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 number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "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 memory (in MB) owned by project", @@ -98304,68 +98665,63 @@ "type": "long" }, { - "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 public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "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", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "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 total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "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" }, { @@ -98374,19 +98730,19 @@ "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" } ], "since": "3.0.0" @@ -98397,12 +98753,12 @@ "name": "updateIpAddress", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the public IP address to update", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { "description": "an optional field, whether to the display the IP to the end user or not", @@ -98413,69 +98769,29 @@ "type": "boolean" }, { - "description": "the ID of the public IP address to update", + "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": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "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", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { @@ -98484,33 +98800,35 @@ "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, + {}, { "description": "public IP address", "name": "ipaddress", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "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": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, + {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -98518,13 +98836,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -98532,14 +98850,19 @@ "name": "resourceid", "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", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -98548,13 +98871,8 @@ "type": "string" }, { - "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" }, { @@ -98563,68 +98881,71 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "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": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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 name of the Network where ip belongs to", - "name": "networkname", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "public IP address id", - "name": "id", + "description": "the 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": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { @@ -98632,312 +98953,218 @@ "name": "allocated", "type": "date" }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - } - ] - }, - { - "description": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ - { - "description": "the account name of the api remaining count", - "name": "account", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, - { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" - }, - { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" - } - ] - }, - { - "description": "Deletes a storage network IP Range.", - "isasync": true, - "name": "deleteStorageNetworkIpRange", - "params": [ + }, { - "description": "the uuid of the storage network ip range", - "length": 255, + "description": "public IP address id", "name": "id", - "related": "createStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "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 zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "moves a network to another physical network", - "isasync": true, - "name": "migrateNetwork", - "params": [ - { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, - "type": "boolean" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], + "related": "", "response": [ { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the account name of the api remaining count", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the account uuid of the api remaining count", + "name": "accountid", "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": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" }, { - "description": "the name of the network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" - }, + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + } + ] + }, + { + "description": "Deletes a storage network IP Range.", + "isasync": true, + "name": "deleteStorageNetworkIpRange", + "params": [ + { + "description": "the uuid of the storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", + "params": [ { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + } + ], + "related": "createNetwork,updateNetwork,listNetworks", + "response": [ + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { @@ -98945,39 +99172,25 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "network offering id the network is created from", + "name": "networkofferingid", "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": "zone id of the network", - "name": "zoneid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { @@ -98986,43 +99199,44 @@ "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "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 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": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -99031,38 +99245,85 @@ "type": "boolean" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "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 network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { @@ -99071,24 +99332,39 @@ "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "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 name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", @@ -99098,15 +99374,15 @@ "name": "name", "type": "string" }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -99116,23 +99392,13 @@ "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -99146,39 +99412,69 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "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": "acl type - access type to the network", - "name": "acltype", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -99187,13 +99483,33 @@ "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "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": "name of the network offering the network is created from", - "name": "networkofferingname", + "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" }, { @@ -99202,38 +99518,78 @@ "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "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": "the project name of the address", "name": "project", "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": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, { "description": "the first DNS for the network", "name": "dns1", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" } ], @@ -99245,12 +99601,11 @@ "name": "addVmwareDc", "params": [ { - "description": "The Zone ID.", + "description": "Name of VMware datacenter to be added to specified zone.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The password for specified username.", @@ -99274,19 +99629,25 @@ "type": "string" }, { - "description": "Name of VMware datacenter to be added to specified zone.", + "description": "The Zone ID.", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + }, {}, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -99295,26 +99656,21 @@ "type": "long" }, { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, - { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "type": "string" - } + {} ] }, { @@ -99323,19 +99679,18 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "customid", + "name": "endport", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the ending port of Ipv6 firewall rule", + "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": "error code for this ICMP message", @@ -99345,19 +99700,19 @@ "type": "integer" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "protocol", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the ipv6 firewall 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": "id", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", @@ -99367,18 +99722,11 @@ "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "cidrlist", + "name": "protocol", "required": false, - "type": "list" + "type": "string" }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -99394,84 +99742,83 @@ "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 protocol of the port forwarding rule", - "name": "protocol", + "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 ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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 public port range", + "name": "publicport", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the 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 starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -99479,8 +99826,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -99489,62 +99841,66 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "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", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" } ], "type": "list" }, - {}, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "name": "publicendport", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" } ] @@ -99555,9 +99911,16 @@ "name": "listUnmanagedInstances", "params": [ { - "description": "the hypervisor name of the instance", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -99577,16 +99940,9 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "the hypervisor name of the instance", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" } @@ -99594,57 +99950,99 @@ "related": "", "response": [ { - "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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" }, { @@ -99653,38 +100051,43 @@ "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -99693,13 +100096,13 @@ "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -99707,64 +100110,97 @@ "name": "vlanid", "type": "integer" }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "set" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the host to which virtual machine belongs", "name": "hostname", "type": "string" }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, - {}, { "description": "the power state of the virtual machine", "name": "powerstate", "type": "string" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "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", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { @@ -99772,92 +100208,22 @@ "name": "cpucorepersocket", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" - }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - } - ], - "type": "set" } ], "since": "4.14.0" @@ -99867,6 +100233,20 @@ "isasync": false, "name": "updateIsoPermissions", "params": [ + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, { "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -99876,18 +100256,18 @@ "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": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "accounts", + "name": "isextractable", "required": false, - "type": "list" + "type": "boolean" }, { "description": "permission operator (add, remove, reset)", @@ -99903,24 +100283,14 @@ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" - }, - { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" } ], "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -99931,17 +100301,13 @@ "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" - } + }, + {}, + {} ] }, { @@ -99950,40 +100316,32 @@ "name": "registerTemplate", "params": [ { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "the tag for this template.", "length": 255, - "name": "isextractable", + "name": "templatetag", "required": false, - "type": "boolean" - }, - { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "passwordenabled", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "isfeatured", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrouting", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", @@ -99993,20 +100351,6 @@ "required": false, "type": "uuid" }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the name of the template", "length": 255, @@ -100015,41 +100359,33 @@ "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "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": "zoneid", - "related": "createZone,listZones", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "directdownload", + "name": "isdynamicallyscalable", "required": false, "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. ", - "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isrouting", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "bits", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the display text of the template. This is usually used for display purposes.", @@ -100059,32 +100395,24 @@ "type": "string" }, { - "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": "Register template for the project", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "ispublic", + "name": "account", "required": false, - "type": "boolean" - }, - { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, "type": "string" }, { @@ -100096,11 +100424,11 @@ "type": "boolean" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "details", + "name": "bits", "required": false, - "type": "map" + "type": "integer" }, { "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", @@ -100110,84 +100438,86 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template requires HVM", "length": 255, - "name": "isdynamicallyscalable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "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": "Register template for the project", "length": 255, - "name": "checksum", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if this template requires HVM", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "requireshvm", + "name": "isfeatured", "required": false, "type": "boolean" - } - ], - "related": "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 account name to which the template belongs", - "name": "account", - "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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 processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the zone the template is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "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. ", + "length": 255, + "name": "zoneids", + "related": "createZone,listZones", + "required": false, + "type": "list" + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { - "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { "description": "the size of the template", @@ -100195,18 +100525,13 @@ "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "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 name of the secondary storage host for the template", - "name": "hostname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -100215,8 +100540,13 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { @@ -100225,24 +100555,25 @@ "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", + "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 account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the status of the template", @@ -100250,58 +100581,73 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, + {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -100310,91 +100656,116 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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 name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the template 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" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { @@ -100403,13 +100774,13 @@ "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -100418,23 +100789,18 @@ "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" } ] @@ -100454,27 +100820,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", + "description": "the current status of the latest async job acting 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" } ] }, @@ -100484,31 +100850,24 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "stratosphere ssp server url", + "description": "stratosphere ssp api name", "length": 255, - "name": "url", + "name": "name", "required": true, "type": "string" }, { - "description": "stratosphere ssp tenant uuid", + "description": "stratosphere ssp api password", "length": 255, - "name": "tenantuuid", + "name": "password", "required": false, "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "stratosphere ssp server url", "length": 255, - "name": "password", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -100520,10 +100879,17 @@ "type": "uuid" }, { - "description": "stratosphere ssp api name", + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "stratosphere ssp tenant uuid", "length": 255, - "name": "name", - "required": true, + "name": "tenantuuid", + "required": false, "type": "string" } ], @@ -100534,31 +100900,31 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "zone which this ssp controls", "name": "zoneid", "type": "string" }, { - "description": "url of ssp endpoint", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "server id of the stratosphere ssp server", "name": "hostid", "type": "string" }, + {}, { "description": "name", "name": "name", "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" } ] @@ -100578,22 +100944,22 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -100623,33 +100989,40 @@ "type": "string" }, { - "description": "the URL of the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the storage provider name", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "provider", + "name": "capacityiops", + "required": false, + "type": "long" + }, + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "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 cluster ID for the storage pool", + "description": "the storage provider name", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { "description": "whether the storage should be managed by CloudStack", @@ -100659,32 +101032,26 @@ "type": "boolean" }, { - "description": "the scope of the storage: cluster or zone", + "description": "the name for the storage pool", "length": 255, - "name": "scope", - "required": false, + "name": "name", + "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.", + "description": "the URL of the storage pool", "length": 255, - "name": "hypervisor", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "capacityiops", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "long" + "type": "uuid" }, { "description": "the details for the storage pool", @@ -100694,25 +101061,19 @@ "type": "map" }, { - "description": "the Pod ID for the storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "capacitybytes", "required": false, - "type": "uuid" + "type": "long" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { "description": "the host's currently used disk size", @@ -100720,40 +101081,45 @@ "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 ID of the storage pool", - "name": "id", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "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 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 current status of the latest async job acting on this object", @@ -100761,8 +101127,8 @@ "type": "integer" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -100770,25 +101136,19 @@ "name": "allocatediops", "type": "long" }, - {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -100797,39 +101157,40 @@ "type": "storagepoolstatus" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the 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": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "true if this pool is suitable to migrate a volume, false otherwise", @@ -100837,14 +101198,19 @@ "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ] }, @@ -100854,11 +101220,18 @@ "name": "findStoragePoolsForMigration", "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": "the ID of the volume", @@ -100869,86 +101242,68 @@ "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": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the total disk size of the storage pool", "name": "disksizetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 type", + "name": "type", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool path", + "name": "path", "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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -100956,24 +101311,31 @@ "name": "created", "type": "date" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage pool path", - "name": "path", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the name of the storage pool", + "name": "name", "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" }, { @@ -100981,45 +101343,49 @@ "name": "clusterid", "type": "string" }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "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": "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 tags for the storage pool", - "name": "tags", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "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 name of the storage pool", - "name": "name", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { @@ -101035,9 +101401,9 @@ "name": "addOpenDaylightController", "params": [ { - "description": "Username to access the OpenDaylight API", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -101050,9 +101416,9 @@ "type": "uuid" }, { - "description": "Credential to access the OpenDaylight API", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -101067,13 +101433,8 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the url of the controller api", - "name": "url", + "description": "device id of the controller", + "name": "id", "type": "string" }, { @@ -101081,26 +101442,31 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the username to authenticate to the controller", - "name": "username", + "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" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the url of the controller api", + "name": "url", "type": "string" } ] @@ -101111,9 +101477,9 @@ "name": "createZone", "params": [ { - "description": "the second internal DNS for the Zone", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "internaldns2", + "name": "domain", "required": false, "type": "string" }, @@ -101133,9 +101499,16 @@ "type": "uuid" }, { - "description": "the second DNS for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "dns2", + "name": "internaldns1", + "required": true, + "type": "string" + }, + { + "description": "Allocation state of this Zone for allocation of new resources", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, @@ -101147,59 +101520,52 @@ "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "domain", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "guestcidraddress", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the second DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the name of the Zone", "length": 255, - "name": "ip6dns2", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "securitygroupenabled", + "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" - }, - { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "internaldns1", - "required": true, + "name": "internaldns2", + "required": false, "type": "string" }, { @@ -101213,95 +101579,74 @@ "related": "listZones", "response": [ { - "description": "Zone id", - "name": "id", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the 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 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity type", @@ -101309,8 +101654,8 @@ "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -101323,129 +101668,149 @@ "name": "podid", "type": "string" }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "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": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, - {}, { "description": "the name of the containing domain, null for public zones", "name": "domainname", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "Zone description", - "name": "description", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "Zone id", + "name": "id", "type": "string" }, { @@ -101453,14 +101818,15 @@ "name": "dns1", "type": "string" }, + {}, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "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" } ] @@ -101482,29 +101848,24 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, {}, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "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", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { @@ -101513,8 +101874,8 @@ "type": "int" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { @@ -101523,35 +101884,40 @@ "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, - {}, { "description": "The mode of the VSM (standalone/HA)", "name": "vsmconfigmode", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "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": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" } ] }, @@ -101561,23 +101927,31 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the beginning IP address", + "description": "the netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the gateway for storage network", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "gateway", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the netmask 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": "netmask", + "name": "vlan", + "required": false, + "type": "integer" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", "required": true, "type": "string" }, @@ -101589,78 +101963,70 @@ "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" - }, - { - "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", - "length": 255, - "name": "vlan", - "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 end ip of the storage network IP range", - "name": "endip", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, + {}, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, { "description": "the 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" } ], @@ -101674,7 +102040,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -101686,6 +102052,13 @@ "required": false, "type": "uuid" }, + { + "description": "list children domains by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, @@ -101701,26 +102074,19 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list children domains by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "flag to display the resource icon for domains", "length": 255, @@ -101732,18 +102098,38 @@ "related": "listDomains", "response": [ { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { @@ -101752,23 +102138,49 @@ "type": "float" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { @@ -101777,39 +102189,43 @@ "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, - {}, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "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 memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { @@ -101817,20 +102233,20 @@ "name": "parentdomainid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "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 state of the domain", + "name": "state", "type": "string" }, { @@ -101839,63 +102255,48 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "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 total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "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" }, { @@ -101904,88 +102305,53 @@ "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, - { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" - }, { "description": "the total memory (in MB) the domain can own", "name": "memorylimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "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 number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" } ] @@ -102011,18 +102377,18 @@ "name": "jobid", "type": "string" }, - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The base64 encoded encrypted password of the VM", "name": "encryptedpassword", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {}, + {} ] }, { @@ -102038,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, @@ -102052,15 +102411,16 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -102071,12 +102431,18 @@ "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" + }, + {}, + {} ] }, { @@ -102085,44 +102451,44 @@ "name": "configureOvsElement", "params": [ { - "description": "the ID of the ovs provider", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "id", - "related": "configureOvsElement", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", + "description": "the ID of the ovs provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureOvsElement", "required": true, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, {}, - {}, { - "description": "the id of the ovs", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account associated with the provider", @@ -102130,13 +102496,13 @@ "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -102145,14 +102511,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the ovs", + "name": "id", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" } ] }, @@ -102162,79 +102528,79 @@ "name": "addImageStoreS3", "params": [ { - "description": "S3 endpoint", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "endpoint", - "required": true, - "type": "string" + "name": "sockettimeout", + "required": false, + "type": "integer" }, { - "description": "Connection timeout (milliseconds)", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "connectiontimeout", + "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 secret key", + "description": "S3 endpoint", "length": 255, - "name": "secretkey", + "name": "endpoint", "required": true, "type": "string" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "s3signer", + "name": "usehttps", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Connection TTL (milliseconds)", + "description": "Name of the storage bucket", "length": 255, - "name": "connectionttl", - "required": false, - "type": "integer" + "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": "Name of the storage bucket", + "description": "S3 access key", "length": 255, - "name": "bucket", + "name": "accesskey", "required": true, "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "usehttps", + "name": "usetcpkeepalive", "required": false, "type": "boolean" }, { - "description": "Socket timeout (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "sockettimeout", + "name": "maxerrorretry", "required": false, "type": "integer" } @@ -102242,56 +102608,56 @@ "related": "listImageStores", "response": [ { - "description": "the url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - {}, { "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "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" }, { - "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 name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -102304,14 +102670,14 @@ "type": "scopetype" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "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" } ], "since": "4.7.0" @@ -102322,12 +102688,11 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) the host ID to upload certificate", + "description": "Hypervisor type", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { "description": "Zone to upload certificate", @@ -102338,16 +102703,17 @@ "type": "uuid" }, { - "description": "Name for the uploaded certificate", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "Hypervisor type", + "description": "Name for the uploaded certificate", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, @@ -102362,27 +102728,15 @@ "related": "", "response": [ { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" - }, - { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, - {}, { "description": "the direct download certificate issuer", "name": "issuer", @@ -102393,39 +102747,51 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, + {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "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 version", - "name": "version", + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" } ], @@ -102437,40 +102803,34 @@ "name": "importUnmanagedInstance", "params": [ { - "description": "the display name of the instance", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "displayname", + "name": "datadiskofferinglist", "required": false, - "type": "string" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "type": "map" }, { - "description": "used to specify the custom parameters.", + "description": "the display name of the instance", "length": 255, - "name": "details", + "name": "displayname", "required": false, - "type": "map" + "type": "string" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "nicnetworklist", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "import instance to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "VM is imported despite some of its NIC's MAC addresses are already present", @@ -102480,34 +102840,32 @@ "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the hypervisor name of the instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "import instance to the domain specified", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the host name of the instance", + "description": "used to specify the custom parameters.", "length": 255, - "name": "hostname", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" }, { "description": "import instance for the project", @@ -102518,66 +102876,59 @@ "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "the cluster ID", "length": 255, - "name": "datadiskofferinglist", + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "the host name of the instance", "length": 255, - "name": "migrateallowed", + "name": "hostname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "nicipaddresslist", "required": false, - "type": "uuid" + "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 project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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": "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 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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", @@ -102585,226 +102936,116 @@ "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the 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 name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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 project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "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 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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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": "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -102817,156 +103058,40 @@ "name": "serviceofferingid", "type": "string" }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the 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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, + {}, { "description": "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -102978,8 +103103,13 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -102987,76 +103117,76 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the project name of the group", "name": "project", @@ -103068,8 +103198,8 @@ "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -103080,14 +103210,19 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -103096,66 +103231,56 @@ "type": "string" }, { - "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "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" }, { @@ -103164,9 +103289,14 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -103174,123 +103304,378 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "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" + } + ], + "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "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 disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the 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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the ID of the nic", - "name": "id", + "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", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -103299,13 +103684,13 @@ "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": "the IPv6 address of network", - "name": "ip6address", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -103319,13 +103704,18 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "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": "macaddress", "type": "string" }, { @@ -103334,124 +103724,111 @@ "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - {}, - { - "description": "an alternate display text of the 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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "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": "the name of the affinity group", - "name": "name", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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 account owning the affinity group", - "name": "account", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the ID of the nic", "name": "id", "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -103460,44 +103837,43 @@ "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "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", + "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", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, - {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" } ], @@ -103518,27 +103894,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": "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" } ] }, @@ -103548,18 +103924,17 @@ "name": "createPhysicalNetwork", "params": [ { - "description": "the Zone ID for the physical network", + "description": "Tag the physical network", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "tags", + "required": false, + "type": "list" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "description": "the name of the physical network", "length": 255, - "name": "broadcastdomainrange", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -103570,23 +103945,25 @@ "type": "string" }, { - "description": "the name of the physical network", + "description": "the Zone ID for the physical network", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tag the physical network", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the speed for the physical network[1G/10G]", + "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": "networkspeed", + "name": "broadcastdomainrange", "required": false, "type": "string" }, @@ -103598,52 +103975,49 @@ "type": "list" }, { - "description": "domain ID of the account owning a physical network", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "networkspeed", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Broadcast domain range of the physical network", @@ -103651,30 +104025,32 @@ "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 vlan of the physical network", - "name": "vlan", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -103691,33 +104067,35 @@ "type": "string" }, { - "description": "the ID of the profile", + "description": "the ID of the loadbalancer", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", + "name": "lbruleid", + "related": "", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the policy", "length": 255, - "name": "pagesize", + "name": "policyid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the autoscale vm group", @@ -103727,20 +104105,6 @@ "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, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -103750,20 +104114,26 @@ "type": "uuid" }, { - "description": "the ID of the loadbalancer", + "description": "the ID of the profile", "length": 255, - "name": "lbruleid", - "related": "", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the availability zone ID", @@ -103774,12 +104144,11 @@ "type": "uuid" }, { - "description": "the ID of the policy", + "description": "List by keyword", "length": 255, - "name": "policyid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -103788,20 +104157,17 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, { "description": "is group for display to the regular user", "name": "fordisplay", @@ -103813,35 +104179,33 @@ "type": "list" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the load balancer 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 project name of the vm profile", + "name": "project", + "type": "string" }, { "description": "the domain ID of the vm profile", "name": "domainid", "type": "string" }, - {}, { - "description": "the account owning the instance group", - "name": "account", + "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": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { @@ -103849,35 +104213,47 @@ "name": "domain", "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": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", "type": "int" }, + {}, { - "description": "the project id vm profile", - "name": "projectid", + "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 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", + "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 minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the account owning the instance group", + "name": "account", + "type": "string" } ] }, @@ -103887,31 +104263,9 @@ "name": "createFirewallRule", "params": [ { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, - { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "error code for this icmp message", + "description": "the ending port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, @@ -103930,6 +104284,21 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, { "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -103937,6 +104306,13 @@ "required": false, "type": "list" }, + { + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, { "description": "the starting port of firewall rule", "length": 255, @@ -103945,9 +104321,9 @@ "type": "integer" }, { - "description": "the ending port of firewall rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" } @@ -103955,33 +104331,23 @@ "related": "updateEgressFirewallRule", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { @@ -103990,59 +104356,83 @@ "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, - {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, { "description": "the protocol of the firewall rule", "name": "protocol", "type": "string" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "the 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 account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project 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" }, { @@ -104051,8 +104441,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104066,33 +104456,19 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } + {} ] }, { @@ -104107,22 +104483,6 @@ "required": false, "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": "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 account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, @@ -104139,11 +104499,12 @@ "type": "uuid" }, { - "description": "Arbitrary volume size", + "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": "size", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" }, { "description": "an optional field, whether to display the volume to the end user or not.", @@ -104153,17 +104514,18 @@ "type": "boolean" }, { - "description": "max iops", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "maxiops", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the ID of the availability zone", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -104175,49 +104537,63 @@ "type": "long" }, { - "description": "the ID of the availability zone", + "description": "Arbitrary volume size", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" + }, { "description": "the name of the disk volume", "length": 255, "name": "name", "required": false, "type": "string" + }, + { + "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "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": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -104226,84 +104602,55 @@ "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "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": "pod id of the volume", - "name": "podid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the availability zone", + "name": "zonename", "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" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "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": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "provisioning type used to create volumes.", @@ -104311,53 +104658,18 @@ "type": "string" }, { - "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", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of 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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -104366,15 +104678,14 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, - {}, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { "description": "min iops of the disk volume", @@ -104382,349 +104693,112 @@ "type": "long" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "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": "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": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "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 ID of 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", - "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 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 service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - { - "description": "the disk utilization", - "name": "utilization", - "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - } - ] - }, - { - "description": "List virtual machine snapshot by conditions", - "isasync": false, - "name": "listVMSnapshot", - "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", - "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "since": "4.9", - "type": "list" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the 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": "lists snapshot by snapshot name or display name", - "length": 255, - "name": "name", - "required": false, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "state of the virtual machine snapshot", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": false, - "type": "uuid" - } - ], - "related": "createVMSnapshot", - "response": [ + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, { - "description": "VM Snapshot type", - "name": "type", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -104733,619 +104807,378 @@ "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the create date of the vm snapshot", + "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 ID of the vm snapshot", - "name": "id", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, - {}, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "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" } - ], - "since": "4.2.0" + ] }, { - "description": "Updates a Pod.", + "description": "List virtual machine snapshot by conditions", "isasync": false, - "name": "updatePod", + "name": "listVMSnapshot", "params": [ { - "description": "the netmask of the Pod", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "netmask", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "the gateway for the Pod", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "gateway", + "name": "account", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "endip", + "name": "listall", "required": false, - "type": "string" - }, - { - "description": "the ID of the Pod", - "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "allocationstate", + "name": "name", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "", "length": 255, - "name": "startip", + "name": "page", "required": false, - "type": "string" - } - ], - "related": "createManagementNetworkIpRange", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "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": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "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 ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": false, + "type": "uuid" }, { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "state of the virtual machine snapshot", + "length": 255, + "name": "state", + "required": false, "type": "string" - } - ] - }, - { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", - "isasync": true, - "name": "moveNetworkAclItem", - "params": [ + }, { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", + "description": "", "length": 255, - "name": "aclconsistencyhash", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "required": true, - "type": "string" + "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "customid", + "name": "projectid", + "related": "activateProject", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "previousaclruleid", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", + "description": "The ID of the VM snapshot", "length": 255, - "name": "nextaclruleid", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "createVMSnapshot", "response": [ { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, {}, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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 ending port of ACL's port range", - "name": "endport", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "indiates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - } - ] - }, - { - "description": "Attaches an ISO to a virtual machine.", - "isasync": true, - "name": "attachIso", - "params": [ - { - "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": "the description of the vm snapshot", + "name": "description", + "type": "string" }, { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" }, { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" - } - ], - "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": "ssh key-pairs", - "name": "keypairs", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -105353,8 +105186,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -105363,486 +105196,547 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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" }, { - "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 account associated with the tag", + "name": "account", "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 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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Updates a Pod.", + "isasync": false, + "name": "updatePod", + "params": [ { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the netmask of the Pod", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, "type": "string" - }, + } + ], + "related": "createManagementNetworkIpRange", + "response": [ {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "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 account associated with the virtual machine", - "name": "account", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + } + ], + "type": "list" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - {}, + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + } + ], + "type": "list" + } + ] + }, + { + "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "isasync": true, + "name": "moveNetworkAclItem", + "params": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "The ID of the network ACL rule that is being moved to a new position.", + "length": 255, + "name": "id", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "length": 255, + "name": "previousaclruleid", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", + "length": 255, + "name": "aclconsistencyhash", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "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 ACL Item", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 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 cidr of IPv6 network", - "name": "ip6cidr", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account associated with the tag", + "name": "account", "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" } ], - "type": "set" + "type": "list" + }, + {}, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Attaches an ISO to a virtual machine.", + "isasync": true, + "name": "attachIso", + "params": [ + { + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", + "length": 255, + "name": "forced", + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, { "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { "description": "the domain ID of the affinity group", @@ -105850,18 +105744,18 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -105870,91 +105764,107 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { @@ -105962,69 +105872,19 @@ "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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", @@ -106035,13 +105895,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -106050,18 +105905,18 @@ "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 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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -106070,24 +105925,74 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -106095,23 +106000,23 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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 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": "tag key name", + "name": "key", "type": "string" }, { @@ -106120,79 +106025,104 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "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": "tag key name", - "name": "key", + "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 project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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 egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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": "tag value", - "name": "value", + "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" }, { @@ -106206,18 +106136,13 @@ "type": "string" }, { - "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 domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -106229,19 +106154,14 @@ "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the protocol of the security group rule", @@ -106249,28 +106169,13 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -106282,12 +106187,493 @@ "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "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 disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "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" + }, + {}, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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 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 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "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", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" } ] }, @@ -106306,11 +106692,10 @@ } ], "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", @@ -106318,15 +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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -106342,20 +106728,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "DHCP server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "the Physical Network ID", "length": 255, @@ -106377,28 +106749,48 @@ "name": "dhcpservertype", "required": false, "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "DHCP server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" } ], "related": "", "response": [ { - "description": "device id of ", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" + }, + {}, + { + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -106406,16 +106798,10 @@ "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": "dhcpservertype", + "name": "provider", "type": "string" } ] @@ -106437,8 +106823,13 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "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" }, { @@ -106447,9 +106838,9 @@ "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" }, { "description": "the date and time the storage pool was created", @@ -106457,43 +106848,28 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "description": "true if 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 scope of the storage pool", - "name": "scope", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -106502,64 +106878,64 @@ "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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 tags for the storage pool", - "name": "tags", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -106567,16 +106943,26 @@ "name": "state", "type": "storagepoolstatus" }, + { + "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", + "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 name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" } ] }, @@ -106588,29 +106974,29 @@ "related": "", "response": [ { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "DN password", - "name": "bindpass", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, + {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -106618,17 +107004,17 @@ "name": "queryfilter", "type": "string" }, + {}, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DN password", + "name": "bindpass", "type": "string" }, - {}, { "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", "name": "ssl", @@ -106657,17 +107043,25 @@ "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": "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": "uuid" + }, + { + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { @@ -106678,12 +107072,11 @@ "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "userid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "firstname", @@ -106693,41 +107086,35 @@ "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" - }, - { - "description": "Unique username.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "username", - "required": true, + "name": "timezone", + "required": false, "type": "string" } ], "related": "getUser", "response": [ + {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the ID of the role", @@ -106735,9 +107122,19 @@ "type": "string" }, { - "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 email address", + "name": "email", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { "description": "the account name of the user", @@ -106745,24 +107142,23 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, - {}, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -106770,24 +107166,34 @@ "name": "domainid", "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 type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user state", - "name": "state", + "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" }, { @@ -106796,40 +107202,20 @@ "type": "resourceiconresponse" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - {}, { "description": "the account ID of the user", "name": "accountid", "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" } ] }, @@ -106849,19 +107235,9 @@ "related": "", "response": [ { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "comma separated related apis", - "name": "related", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "version of CloudStack the api was introduced in", @@ -106869,95 +107245,105 @@ "type": "string" }, { - "description": "the list params the api accepts", - "name": "params", + "description": "api response fields", + "name": "response", "response": [ { - "description": "description of the api parameter", - "name": "description", - "type": "string" - }, - { - "description": "length of the parameter", - "name": "length", - "type": "int" - }, - { - "description": "the name of the api parameter", - "name": "name", - "type": "string" - }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "description of the api response field", + "name": "description", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "api response fields", + "name": "response", + "type": "set" }, { - "description": "parameter type", - "name": "type", + "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description of the api", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "response field type", + "name": "type", + "type": "string" }, - {}, { "description": "true if api is asynchronous", "name": "isasync", "type": "boolean" }, {}, + {}, { - "description": "api response fields", - "name": "response", + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "description of the api response field", + "description": "comma separated related apis to get the parameter", + "name": "related", + "type": "string" + }, + { + "description": "description of the api parameter", "name": "description", "type": "string" }, { - "description": "the name of the api response field", + "description": "parameter type", + "name": "type", + "type": "string" + }, + { + "description": "the name of the api parameter", "name": "name", "type": "string" }, { - "description": "response field type", - "name": "type", + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "length of the parameter", + "name": "length", + "type": "int" } ], "type": "set" - }, - { - "description": "description of the api", - "name": "description", - "type": "string" } ], "since": "4.1.0" @@ -106977,28 +107363,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -107026,45 +107412,33 @@ "related": "", "response": [ { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", "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", - "name": "fordisplay", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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 vpc name of this gateway", - "name": "vpcname", + "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" }, { @@ -107073,23 +107447,35 @@ "type": "date" }, { - "description": "the project name", - "name": "project", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" } ] @@ -107107,9 +107493,9 @@ "type": "boolean" }, { - "description": "The display name of the snapshot", + "description": "The description of the snapshot", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, @@ -107121,9 +107507,9 @@ "type": "boolean" }, { - "description": "The description of the snapshot", + "description": "The display name of the snapshot", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, @@ -107138,44 +107524,40 @@ ], "related": "", "response": [ - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "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 description of the vm snapshot", - "name": "description", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, + {}, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { @@ -107184,8 +107566,8 @@ "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { @@ -107193,51 +107575,19 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -107245,8 +107595,18 @@ "name": "tags", "response": [ { - "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", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -107259,24 +107619,19 @@ "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", + "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" }, { @@ -107285,32 +107640,63 @@ "type": "string" }, { - "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" } ], "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "indiates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the name of the vm snapshot", - "name": "name", + "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 ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" + }, + { + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "VM Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" } ], "since": "4.2.0" @@ -107320,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, @@ -107341,38 +107734,31 @@ "name": "resourceid", "required": true, "type": "string" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -107389,12 +107775,11 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username of the vpn user.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -107404,26 +107789,27 @@ "type": "string" }, { - "description": "", + "description": "The uuid of the Vpn user", "length": 255, - "name": "page", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The uuid of the Vpn user", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "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.", @@ -107433,80 +107819,80 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the username of the vpn user.", + "description": "", "length": 255, - "name": "username", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "addVpnUser", "response": [ {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the state of the Vpn User", - "name": "state", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the state of the Vpn User", + "name": "state", "type": "string" }, + {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -107525,23 +107911,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": "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", @@ -107565,7 +107951,6 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -107573,9 +107958,9 @@ }, {}, { - "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", @@ -107583,10 +107968,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" + }, + {} ] }, { @@ -107618,20 +108004,30 @@ ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the end point of the region", "name": "endpoint", "type": "string" }, + { + "description": "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": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, { "description": "true if security groups support is enabled, false otherwise", @@ -107639,22 +108035,12 @@ "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" - } + {} ] }, { @@ -107702,12 +108088,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -107716,12 +108102,12 @@ "name": "updateRolePermission", "params": [ { - "description": "ID of the role", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "roleid", + "name": "ruleorder", "related": "", - "required": true, - "type": "uuid" + "required": false, + "type": "list" }, { "description": "Rule permission, can be: allow or deny", @@ -107732,12 +108118,12 @@ "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "ID of the role", "length": 255, - "name": "ruleorder", + "name": "roleid", "related": "", - "required": false, - "type": "list" + "required": true, + "type": "uuid" }, { "description": "Role permission rule id", @@ -107755,23 +108141,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": "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.9.0" }, @@ -107781,31 +108167,23 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "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. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -107817,19 +108195,19 @@ "type": "string" }, { - "description": "the ID of the ssh keypair", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -107854,61 +108232,69 @@ "type": "string" }, { - "description": "A public key fingerprint to look for", + "description": "the ID of the ssh keypair", "length": 255, - "name": "fingerprint", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the owner of the keypair", - "name": "account", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the owner of the keypair", + "name": "account", + "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Name of the keypair", + "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the domain id of the keypair owner", "name": "domainid", "type": "string" + }, + { + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" } ] }, @@ -107918,149 +108304,184 @@ "name": "listAccounts", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "isrecursive", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list account by account ID", + "description": "list account by account name", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "pagesize", + "name": "iscleanuprequired", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "list account by account ID", "length": 255, - "name": "details", + "name": "id", + "related": "enableAccount,listAccounts,listAccounts", "required": false, - "type": "list" + "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": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "iscleanuprequired", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "flag to display the resource icon for accounts", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "showicon", + "name": "accounttype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "list account by account name", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "accounttype", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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 name of the role", - "name": "rolename", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "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 networks available to be created for this account", - "name": "networkavailable", + "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 secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { @@ -108068,129 +108489,169 @@ "name": "vmstopped", "type": "integer" }, + {}, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, { "description": "the total number of vpcs owned by account", "name": "vpctotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the account", - "name": "id", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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 default zone of the account", - "name": "defaultzoneid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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 volume being used by this account", - "name": "volumetotal", + "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": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 account ID of the user", - "name": "accountid", - "type": "string" - }, { "description": "the user lastname", "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -108199,23 +108660,23 @@ "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -108224,24 +108685,19 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the account type of the user", @@ -108249,8 +108705,13 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -108259,13 +108720,18 @@ "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 user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -108274,119 +108740,64 @@ "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "list" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of 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": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, - {}, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "true if the account requires cleanup", "name": "iscleanuprequired", @@ -108398,39 +108809,14 @@ "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "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 total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" } ] }, @@ -108451,39 +108837,39 @@ "related": "", "response": [ { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "the tags for the storage pool", @@ -108491,85 +108877,85 @@ "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "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": "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 Zone name of the storage pool", - "name": "zonename", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the Zone ID of the storage pool", @@ -108577,20 +108963,20 @@ "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "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 scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ] }, @@ -108611,65 +108997,180 @@ "related": "", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], - "type": "list" + "type": "set" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -108678,48 +109179,38 @@ "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "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": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -108728,54 +109219,49 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "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", @@ -108783,58 +109269,105 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "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 state of the router", + "name": "state", + "type": "state" + }, { "description": "the template ID for the router", "name": "templateid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "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 name of VPC the router belongs to", - "name": "vpcname", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -108843,203 +109376,66 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the Pod name for the router", - "name": "podname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, + {}, + {}, { - "description": "the version of template", - "name": "version", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the 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 first DNS for the router", - "name": "dns1", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the account associated with the router", + "name": "account", "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 Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the 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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "the template name for the router", + "name": "templatename", + "type": "string" } ] }, @@ -109049,12 +109445,12 @@ "name": "updateSnapshotPolicy", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the snapshot policy", "length": 255, - "name": "customid", + "name": "id", + "related": "updateSnapshotPolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { "description": "an optional field, whether to the display the snapshot policy to the end user or not.", @@ -109065,12 +109461,12 @@ "type": "boolean" }, { - "description": "the ID of the snapshot policy", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" } ], "related": "", @@ -109081,38 +109477,23 @@ "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -109121,67 +109502,82 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - {}, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + {}, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" } ] @@ -109192,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", @@ -109202,25 +109598,16 @@ ], "related": "", "response": [ - { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - }, - { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, + {}, { "description": "the result code for the job", "name": "jobresultcode", "type": "integer" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { "description": " the created date of the job", @@ -109228,24 +109615,19 @@ "type": "date" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { "description": "the account that executed the async command", @@ -109253,27 +109635,41 @@ "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 async command executed", - "name": "cmd", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, {}, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" + } ] }, { @@ -109281,6 +109677,13 @@ "isasync": true, "name": "registerNetscalerControlCenter", "params": [ + { + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "Credentials to reach netscaler controlcenter device", "length": 255, @@ -109301,92 +109704,75 @@ "name": "ipaddress", "required": true, "type": "string" - }, - { - "description": "Credentials to reach netscaler controlcenter device", - "length": 255, - "name": "password", - "required": true, - "type": "string" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "response": [ { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, { "description": "the physical network to which this netscaler device belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "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": "name of the provider", - "name": "provider", + "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", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "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": "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", + "type": "string" + }, { "description": "the private interface of the load balancer", "name": "privateinterface", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "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": "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": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -109395,9 +109781,19 @@ "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -109407,94 +109803,79 @@ "name": "listImageStores", "params": [ { - "description": "the name of the image store", + "description": "the image store protocol", "length": 255, - "name": "name", + "name": "protocol", "required": false, "type": "string" }, { - "description": "read-only status of the image store", + "description": "", "length": 255, - "name": "readonly", - "related": "listImageStores", + "name": "page", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the image store provider", "length": 255, - "name": "pagesize", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the name of the image store", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the storage pool", + "description": "read-only status of the image store", "length": 255, - "name": "id", + "name": "readonly", "related": "listImageStores", "required": false, - "type": "uuid" + "since": "4.15.0", + "type": "boolean" }, { - "description": "the image store protocol", + "description": "the ID of the storage pool", "length": 255, - "name": "protocol", + "name": "id", + "related": "listImageStores", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the image store provider", + "description": "the Zone ID for the image store", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the protocol of the image store", @@ -109502,8 +109883,8 @@ "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -109511,43 +109892,58 @@ "name": "zoneid", "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": "the Zone name of the image store", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the url of the image store", - "name": "url", + "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, - {} + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + } ], "since": "4.2.0" }, @@ -109571,22 +109967,22 @@ "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -109619,26 +110015,20 @@ ], "related": "", "response": [ + {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Source of the counter.", + "name": "source", "type": "string" }, - {}, { "description": "Name of the counter.", "name": "name", "type": "string" }, - {}, - { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, { - "description": "Source of the counter.", - "name": "source", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -109647,14 +110037,20 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" } ] }, @@ -109665,7 +110061,6 @@ "params": [], "related": "", "response": [ - {}, { "description": "Event Type", "name": "name", @@ -109676,12 +110071,13 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ] }, { @@ -109701,13 +110097,13 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -109716,9 +110112,9 @@ "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the operation result description", @@ -109726,47 +110122,47 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", + "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 interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface address", + "name": "address", "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 action (if issued)", - "name": "action", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" - }, - {} + } ], "since": "4.9.0" }, @@ -109776,38 +110172,23 @@ "name": "addCluster", "params": [ { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "ovm3vip", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "password", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the Zone ID for the cluster", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", - "length": 255, - "name": "hypervisor", - "required": true, - "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": "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": "publicvswitchtype", + "name": "guestvswitchtype", "required": false, "type": "string" }, @@ -109827,144 +110208,145 @@ "type": "uuid" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the Zone ID for the cluster", "length": 255, - "name": "vsmpassword", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the username for the cluster", + "length": 255, + "name": "username", "required": false, "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "ovm3pool", + "name": "vsmipaddress", "required": false, "type": "string" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the password for the host", "length": 255, - "name": "publicvswitchname", + "name": "password", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "guestvswitchtype", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "the username for the cluster", + "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "username", + "name": "publicvswitchtype", "required": false, "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "vsmipaddress", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "vsmusername", + "name": "ovm3cluster", "required": false, "type": "string" }, { - "description": "the URL", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "url", + "name": "publicvswitchname", "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 username for the VSM associated with this cluster", "length": 255, - "name": "guestvswitchname", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "clustertype", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "allocationstate", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the URL", "length": 255, - "name": "ovm3cluster", + "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" } ], "related": "", "response": [ - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, { "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, + {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", + "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 name", - "name": "name", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -109973,8 +110355,13 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -109983,21 +110370,21 @@ "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { @@ -110005,29 +110392,39 @@ "name": "name", "type": "string" }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110035,38 +110432,37 @@ "name": "podid", "type": "string" }, - {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "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 allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + {} ] }, { @@ -110084,27 +110480,27 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ] }, @@ -110133,126 +110529,70 @@ "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "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": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "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 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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the 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 state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { "description": "the memory allocated for the virtual machine", @@ -110260,74 +110600,98 @@ "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the 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 group name of the virtual machine", - "name": "group", + "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" }, { @@ -110336,151 +110700,64 @@ "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the 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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - } - ], - "type": "set" + "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" }, {}, { @@ -110488,73 +110765,43 @@ "name": "securitygroup", "response": [ { - "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", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -110567,29 +110814,14 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "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 value", "name": "value", @@ -110600,6 +110832,11 @@ "name": "resourceid", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", @@ -110610,19 +110847,14 @@ "name": "account", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -110630,6 +110862,11 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", @@ -110637,23 +110874,100 @@ } ], "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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 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 ", @@ -110661,42 +110975,37 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -110705,32 +111014,37 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "account owning the security group rule", @@ -110738,111 +111052,162 @@ "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" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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": "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 account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "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 template for the virtual machine", - "name": "templatename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the 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": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "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" }, { @@ -110850,81 +111215,253 @@ "name": "tags", "response": [ { - "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "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 list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "tag key name", - "name": "key", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -110938,203 +111475,128 @@ "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "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 user's name who deployed the virtual machine", - "name": "username", + "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 host for the virtual machine", - "name": "hostname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + } + ] + }, + { + "description": "Activates a project", + "isasync": true, + "name": "activateProject", + "params": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project account name of the project", + "name": "projectaccountname", "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 project", + "name": "name", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, - {} - ] - }, - { - "description": "Activates a project", - "isasync": true, - "name": "activateProject", - "params": [ - { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ { - "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 domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -111142,53 +111604,47 @@ "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total 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 displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, - {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -111197,8 +111653,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -111212,8 +111668,13 @@ "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", "type": "string" }, { @@ -111230,170 +111691,115 @@ "type": "list" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, - {}, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "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", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "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 public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, + {}, { - "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": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "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" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" } ], "since": "3.0.0" @@ -111413,28 +111819,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "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" + } ] }, { @@ -111450,53 +111856,64 @@ "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" }, { - "description": "the ID of the host", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list dedicated hosts by affinity group", + "description": "List by keyword", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + {}, + { + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", + "type": "string" + }, { "description": "the ID of the host", "name": "hostid", @@ -111507,33 +111924,22 @@ "name": "affinitygroupid", "type": "string" }, - {}, { "description": "the Account ID of the host", "name": "accountid", "type": "string" }, - {}, - { - "description": "the name of the host", - "name": "hostname", - "type": "string" - }, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, - { - "description": "the domain ID of the host", - "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", @@ -111542,87 +111948,68 @@ ] }, { - "description": "Get diagnostics and files from system VMs", - "isasync": true, - "name": "getDiagnosticsData", + "description": "upload an existing ISO into the CloudStack cloud.", + "isasync": false, + "name": "getUploadParamsForIso", "params": [ { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "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": "targetid", + "name": "ostypeid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "description": "the name of the ISO", "length": 255, - "name": "files", - "required": false, - "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "name": "name", + "required": true, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume/template", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ], - "since": "4.14.0.0" - }, - { - "description": "upload an existing ISO into the CloudStack cloud.", - "isasync": false, - "name": "getUploadParamsForIso", - "params": [ - { - "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "checksum", + "name": "isextractable", "required": false, - "type": "string" + "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 this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "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": "account", + "name": "checksum", "required": false, "type": "string" }, { - "description": "the name of the volume/template", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "Upload volume/template for the project", @@ -111655,92 +112042,111 @@ "type": "boolean" }, { - "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 name of the ISO", - "length": 255, - "name": "name", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "the ID of the zone the volume/template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "ispublic", + "name": "account", "required": false, - "type": "boolean" + "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 timestamp after which the signature expires", - "name": "expires", + "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": "signature to be sent in the POST request.", - "name": "signature", + "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": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", "type": "string" }, {} ], - "since": "4.13" + "since": "4.14.0.0" }, { "description": "Deletes a autoscale vm group.", @@ -111758,27 +112164,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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" - }, - {} + } ] }, { @@ -111787,20 +112193,11 @@ "name": "listPaloAltoFirewalls", "params": [ { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -111810,11 +112207,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "keyword", + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -111822,18 +112220,26 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "addPaloAltoFirewall", "response": [ { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { @@ -111842,13 +112248,18 @@ "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "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 zone ID of the external firewall", - "name": "zoneid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { @@ -111857,41 +112268,36 @@ "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "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": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the timeout (in seconds) for requests to the external firewall", "name": "timeout", "type": "string" }, + {}, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { "description": "the public security zone of the external firewall", @@ -111899,23 +112305,23 @@ "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" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -111933,9 +112339,17 @@ "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, @@ -111955,14 +112369,6 @@ "since": "4.4", "type": "string" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, @@ -111971,9 +112377,9 @@ "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", "required": false, "type": "string" } @@ -111981,43 +112387,38 @@ "related": "listLoadBalancerRules", "response": [ { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112025,21 +112426,9 @@ "name": "domainid", "type": "string" }, - {}, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - {}, { - "description": "the public port", - "name": "publicport", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -112047,33 +112436,28 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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" }, { @@ -112087,68 +112471,90 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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 id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the state of the rule", "name": "state", "type": "string" }, + {}, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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 project name of the load balancer", - "name": "project", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + {} ] }, { @@ -112157,12 +112563,11 @@ "name": "deleteAlerts", "params": [ { - "description": "the IDs of the alerts", + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "ids", - "related": "", + "name": "enddate", "required": false, - "type": "list" + "type": "date" }, { "description": "delete by alert type", @@ -112179,35 +112584,36 @@ "type": "date" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the alerts", "length": 255, - "name": "enddate", + "name": "ids", + "related": "", "required": false, - "type": "date" + "type": "list" } ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -112216,6 +112622,13 @@ "isasync": false, "name": "enableAccount", "params": [ + { + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Account id", "length": 255, @@ -112231,158 +112644,39 @@ "related": "listDomains", "required": false, "type": "uuid" - }, - { - "description": "Enables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "listAccounts", "response": [ { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "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 name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - } - ], - "type": "list" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -112390,14 +112684,9 @@ "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { "description": "the total number of snapshots stored by this account", @@ -112405,100 +112694,99 @@ "type": "long" }, { - "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", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the 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 list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total 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", + "type": "integer" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "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 number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the total primary storage space (in GiB) available to be used for this account", @@ -112506,95 +112794,198 @@ "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "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": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "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": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the name of the account", + "name": "name", "type": "string" }, + {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, - {}, { - "description": "the name of the account", - "name": "name", + "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 networks owned by account", + "name": "networktotal", + "type": "long" }, { "description": "the total number of virtual machines that can be deployed by this account", @@ -112602,48 +112993,53 @@ "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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 secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -112652,14 +113048,24 @@ "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "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" } ] }, @@ -112669,11 +113075,20 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "destroyvmgraceperiod", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "getUser", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the template of the auto deployed virtual machine", @@ -112683,13 +113098,6 @@ "required": true, "type": "uuid" }, - { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", - "length": 255, - "name": "counterparam", - "required": false, - "type": "map" - }, { "description": "the service offering of the auto deployed virtual machine", "length": 255, @@ -112699,59 +113107,57 @@ "type": "uuid" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "otherdeployparams", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "destroyvmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "counterparam", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", + "name": "otherdeployparams", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "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 ID of the vm profile", + "name": "domainid", + "type": "string" }, {}, - {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112760,19 +113166,25 @@ "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "string" }, + {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" }, { "description": "the availability zone to be used while deploying a virtual machine", @@ -112780,15 +113192,14 @@ "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { @@ -112797,13 +113208,8 @@ "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { @@ -112825,6 +113231,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -112832,6 +113246,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -112847,70 +113268,71 @@ "related": "listLBStickinessPolicies", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the description of the Stickiness policy", - "name": "description", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "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 account of the Stickiness policy", - "name": "account", + "description": "the id of the zone the Stickiness 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 state of the policy", + "name": "state", + "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the method name of the Stickiness policy", "name": "methodname", @@ -112922,13 +113344,13 @@ "type": "map" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { @@ -112937,29 +113359,13 @@ "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the state of the policy", + "name": "state", "type": "string" } ], "type": "list" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -112975,6 +113381,13 @@ "required": true, "type": "string" }, + { + "description": "the username of UCS", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "the Zone id for the ucs manager", "length": 255, @@ -112990,13 +113403,6 @@ "required": true, "type": "string" }, - { - "description": "the username of UCS", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "the name of UCS manager", "length": 255, @@ -113008,18 +113414,13 @@ "related": "", "response": [ { - "description": "the name of ucs manager", - "name": "name", + "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", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { @@ -113027,16 +113428,21 @@ "name": "id", "type": "string" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the url of ucs manager", "name": "url", "type": "string" }, - {}, - {}, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -113063,23 +113469,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": "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", @@ -113104,60 +113510,146 @@ "related": "addBaremetalHost", "response": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + {}, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { "description": "the host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "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": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the name of the host", - "name": "name", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { "description": "the ID of the host", @@ -113165,64 +113657,69 @@ "type": "string" }, { - "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 incoming network traffic on the host", - "name": "networkkbsread", + "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 HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "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 state of the host", + "name": "state", + "type": "status" }, { "description": "the OS category ID of the host", @@ -113230,39 +113727,29 @@ "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "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 Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { "description": "the host out-of-band management information", @@ -113270,199 +113757,118 @@ "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "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 Zone ID of the host", - "name": "zoneid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the amount of the host's memory currently allocated 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": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, - {}, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "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 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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the 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", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, - { - "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": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" } ] }, @@ -113483,110 +113889,95 @@ "related": "", "response": [ { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "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 memory the Kubernetes cluster", "name": "memory", "type": "string" }, - { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the 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": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "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", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { "description": "the project name of the Kubernetes cluster", @@ -113594,33 +113985,48 @@ "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "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 service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { @@ -113629,34 +114035,39 @@ "type": "boolean" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, {}, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" } ] @@ -113666,14 +114077,6 @@ "isasync": true, "name": "deleteProject", "params": [ - { - "description": "id of the project to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "true if all project resources have to be cleaned up, false otherwise", "length": 255, @@ -113681,30 +114084,38 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "id of the project to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -113715,10 +114126,10 @@ "name": "listNetscalerLoadBalancers", "params": [ { - "description": "the Physical Network ID", + "description": "netscaler load balancer device ID", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "required": false, "type": "uuid" }, @@ -113730,11 +114141,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -113744,29 +114156,28 @@ "type": "integer" }, { - "description": "netscaler load balancer device ID", + "description": "List by keyword", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addNetscalerLoadBalancer", "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": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { @@ -113775,70 +114186,70 @@ "type": "long" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "name": "podids", "type": "list" }, { - "description": "device name", - "name": "lbdevicename", + "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "device name", + "name": "lbdevicename", "type": "string" }, {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { "description": "device id of the netscaler load balancer", "name": "lbdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -113849,13 +114260,20 @@ "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 name of the instance group", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, @@ -113864,79 +114282,72 @@ "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" - }, - { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the name of the instance group", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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 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": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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 project name of the instance group", - "name": "project", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" } ] }, @@ -113956,33 +114367,18 @@ ], "related": "listTemplatePermissions,listIsoPermissions", "response": [ - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - {}, { "description": "the template ID", "name": "id", "type": "string" }, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, + {}, {}, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the list of projects the template is available for", "name": "projectids", @@ -113992,6 +114388,21 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" } ] }, @@ -114001,11 +114412,11 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "public IP of the site", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "gslbproviderpublicip", + "name": "gslbprovider", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", @@ -114015,46 +114426,46 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", "length": 255, - "name": "gslbprovider", + "name": "isexclusivegslbprovider", "required": false, "type": "boolean" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "isexclusivegslbprovider", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" }, { - "description": "private IP of the site", + "description": "public IP of the site", "length": 255, - "name": "gslbproviderprivateip", + "name": "gslbproviderpublicip", "required": false, "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "private IP of the site", "length": 255, - "name": "password", - "required": true, + "name": "gslbproviderprivateip", + "required": false, "type": "string" }, { @@ -114068,54 +114479,60 @@ "related": "", "response": [ { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "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": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { "description": "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the management IP address of the external load balancer", @@ -114123,35 +114540,29 @@ "type": "string" }, {}, - { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, { "description": "the public interface of the load balancer", "name": "publicinterface", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, - {}, { - "description": "device 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": "name of the provider", - "name": "provider", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" } ] @@ -114162,37 +114573,45 @@ "name": "createLoadBalancer", "params": [ { - "description": "name of the load balancer", + "description": "the network id of the source ip address", "length": 255, - "name": "name", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "scheme", + "name": "algorithm", "required": true, "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "name of the load balancer", "length": 255, - "name": "algorithm", + "name": "name", "required": true, "type": "string" }, { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "instanceport", + "required": true, + "type": "integer" + }, + { + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "the source port the network traffic will be load balanced from", "length": 255, - "name": "instanceport", + "name": "sourceport", "required": true, "type": "integer" }, @@ -114205,19 +114624,18 @@ "type": "uuid" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "sourceipaddress", - "required": false, + "name": "scheme", + "required": true, "type": "string" }, { - "description": "the network id of the source ip address", - "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "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", @@ -114226,101 +114644,47 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" } ], "related": "", "response": [ - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, { "description": "Load Balancer source ip", "name": "sourceipaddress", "type": "string" }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - } - ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "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 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 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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -114329,68 +114693,94 @@ "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, - {}, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { @@ -114419,6 +114809,27 @@ } ], "type": "list" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + {}, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" } ], "since": "4.2.0" @@ -114429,45 +114840,38 @@ "name": "removeNetworkPermissions", "params": [ { - "description": "the network ID", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "name": "accounts", + "required": false, + "type": "list" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "listAccounts", + "name": "projectids", + "related": "", "required": false, "type": "list" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "the network ID", "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "", + "name": "accountids", + "related": "listAccounts", "required": false, "type": "list" } ], "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", @@ -114478,11 +114882,18 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.17.0" }, @@ -114498,17 +114909,10 @@ "required": false, "type": "string" }, - { - "description": "Pxe server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -114520,35 +114924,36 @@ "required": true, "type": "uuid" }, + { + "description": "Pxe server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "url", + "name": "url", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "url", - "name": "url", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -114558,9 +114963,15 @@ }, {}, { - "description": "name of the provider", - "name": "provider", + "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" } ] }, @@ -114570,57 +114981,67 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "supports only PaloAltoFirewall", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "networkdevicetype", + "name": "url", "required": true, "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "supports only PaloAltoFirewall", "length": 255, - "name": "username", + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "URL of the Palo Alto appliance.", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "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 timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -114629,13 +115050,13 @@ "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 physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, {}, @@ -114645,13 +115066,8 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { @@ -114660,44 +115076,39 @@ "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - {}, - { - "description": "device name", - "name": "fwdevicename", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -114708,11 +115119,12 @@ "name": "createPrivateGateway", "params": [ { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "The isolated network this private gateway is associated to.", @@ -114724,27 +115136,19 @@ "type": "uuid" }, { - "description": "the IP address of the Private gateaway", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - }, - { - "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": "the ID of the network ACL", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the network implementation uri for the private gateway", @@ -114754,19 +115158,34 @@ "type": "string" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "the netmask of the Private gateway", "length": 255, - "name": "sourcenatsupported", + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "the uuid of the network offering to use for the private gateways network connection", + "length": 255, + "name": "networkofferingid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the gateway of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "gateway", + "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, + "name": "sourcenatsupported", + "required": false, + "type": "boolean" + }, { "description": "the VPC network belongs to", "length": 255, @@ -114776,112 +115195,105 @@ "type": "uuid" }, { - "description": "the netmask of the Private gateway", + "description": "the gateway of the Private gateway", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" - }, - { - "description": "the uuid of the network offering to use for the private gateways network connection", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "createPrivateGateway", "response": [ { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, + {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, + {}, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the id of the private gateway", + "name": "id", "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 private gateway", + "name": "domain", + "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "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 private gateway's netmask", - "name": "netmask", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { @@ -114890,13 +115302,13 @@ "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "Souce Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { @@ -114904,16 +115316,15 @@ "name": "associatednetwork", "type": "string" }, - {}, { - "description": "the gateway", - "name": "gateway", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.17.0" @@ -114934,58 +115345,69 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user email address", + "name": "email", "type": "string" }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the ID of the role", "name": "roleid", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, + {}, { "description": "the user firstname", "name": "firstname", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -114994,66 +115416,55 @@ "type": "resourceiconresponse" }, { - "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", + "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 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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user name", + "name": "username", + "type": "string" } ] }, @@ -115063,56 +115474,57 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list by network ID the rule belongs to", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "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 load balancer rule", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "name", + "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": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "boolean" + "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", @@ -115123,117 +115535,111 @@ "type": "uuid" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "the name of the load balancer rule", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "the 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": "id", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the availability zone ID", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the description of the load balancer", - "name": "description", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "the public ip address", - "name": "publicip", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the 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 public ip address id", - "name": "publicipid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, + {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -115242,19 +115648,23 @@ "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 public port", - "name": "publicport", + "description": "the name of the load balancer", + "name": "name", "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" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -115262,14 +115672,15 @@ "name": "fordisplay", "type": "boolean" }, + {}, { "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 private port", + "name": "privateport", "type": "string" }, { @@ -115287,23 +115698,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -115312,46 +115723,46 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the state of the rule", - "name": "state", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public port", + "name": "publicport", "type": "string" } ] @@ -115371,28 +115782,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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -115401,33 +115812,26 @@ "name": "uploadSslCert", "params": [ { - "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" - }, - { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, "type": "string" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "Password for the private key", + "description": "Enables revocation checking for certificates", "length": 255, - "name": "password", + "name": "enabledrevocationcheck", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { "description": "Name for the uploaded certificate", @@ -115436,14 +115840,6 @@ "required": true, "type": "string" }, - { - "description": "Enables revocation checking for certificates", - "length": 255, - "name": "enabledrevocationcheck", - "required": false, - "since": "4.15", - "type": "boolean" - }, { "description": "SSL certificate", "length": 16384, @@ -115452,9 +115848,24 @@ "type": "string" }, { - "description": "account that will own the SSL certificate", + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" + }, + { + "description": "domain ID of the account owning the SSL certificate", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", "required": false, "type": "string" }, @@ -115469,36 +115880,30 @@ ], "related": "", "response": [ - {}, - { - "description": "account for the certificate", - "name": "account", - "type": "string" - }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "certificate fingerprint", + "name": "fingerprint", "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 project id of the certificate", - "name": "projectid", + "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" }, { @@ -115506,24 +115911,30 @@ "name": "domain", "type": "string" }, + {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name", - "name": "name", + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" + }, + { + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { @@ -115532,9 +115943,9 @@ "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "certificate chain", + "name": "certchain", + "type": "string" } ] }, @@ -115544,23 +115955,24 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "guest cidr list 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": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "esplifetime", + "name": "splitconnections", "required": false, - "type": "long" + "since": "4.15.1", + "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "gateway", "required": true, "type": "string" }, @@ -115572,28 +115984,12 @@ "type": "boolean" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" - }, - { - "description": "ESP policy of the customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "esppolicy", + "name": "ikepolicy", "required": true, "type": "string" }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", - "type": "string" - }, { "description": "name of this customer gateway", "length": 255, @@ -115602,25 +115998,27 @@ "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikelifetime", + "name": "esplifetime", "required": false, "type": "long" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "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": "account", + "name": "ikeversion", "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { "description": "create site-to-site VPN customer gateway for the project", @@ -115632,19 +116030,32 @@ "type": "uuid" }, { - "description": "IKE policy of the customer gateway", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikepolicy", + "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": "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": "ESP policy of the customer gateway", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "esppolicy", + "required": true, + "type": "string" + }, + { + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "If DPD is enabled for VPN connection", @@ -115657,18 +116068,28 @@ "related": "", "response": [ { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { @@ -115677,18 +116098,18 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the 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 project id", - "name": "projectid", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { @@ -115697,14 +116118,14 @@ "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { "description": "the project name", @@ -115712,13 +116133,8 @@ "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -115727,52 +116143,47 @@ "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the owner", - "name": "account", + "description": "name of the customer gateway", + "name": "name", "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", + "name": "projectid", "type": "string" }, + {}, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "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" + } ] }, { @@ -115781,9 +116192,9 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The netmask for the management network.", + "description": "The gateway for the management network.", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, @@ -115802,18 +116213,10 @@ "type": "boolean" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The netmask for the management network.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "netmask", "required": true, - "type": "uuid" - }, - { - "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": "vlan", - "required": false, "type": "string" }, { @@ -115824,164 +116227,161 @@ "type": "string" }, { - "description": "The gateway 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": "gateway", - "required": true, + "name": "vlan", + "required": false, "type": "string" + }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, + {}, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - {}, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "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", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "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 Pod ID", - "name": "podid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { @@ -115990,13 +116390,18 @@ "type": "integer" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "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", + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { @@ -116005,9 +116410,15 @@ "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + {}, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" } ], "since": "4.11.0.0" @@ -116017,6 +116428,14 @@ "isasync": false, "name": "listCiscoNexusVSMs", "params": [ + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -116045,36 +116464,28 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { @@ -116082,52 +116493,52 @@ "name": "vsmdevicestate", "type": "string" }, - {}, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, { "description": "storage vlan id of the VSM", "name": "vsmstoragevlanid", "type": "int" }, + {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, + {}, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" } ] }, @@ -116136,13 +116547,6 @@ "isasync": true, "name": "addVpnUser", "params": [ - { - "description": "password for the username", - "length": 255, - "name": "password", - "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, @@ -116152,11 +116556,12 @@ "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "add vpn user to the specific project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "username for the vpn user", @@ -116166,56 +116571,57 @@ "type": "string" }, { - "description": "add vpn user to the specific project", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "password for the username", + "length": 255, + "name": "password", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the vpn userID", + "name": "id", "type": "string" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the username of the vpn user", + "name": "username", "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 vpn userID", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, - {}, { "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, - { - "description": "the username of the vpn user", - "name": "username", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { @@ -116224,8 +116630,13 @@ "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "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" } ] @@ -116236,20 +116647,18 @@ "name": "addBaremetalHost", "params": [ { - "description": "the Zone ID for the host", + "description": "the host URL", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "hypervisor type of the host", "length": 255, - "name": "podid", - "related": "", + "name": "hypervisor", "required": true, - "type": "uuid" + "type": "string" }, { "description": "list of tags to be added to the host", @@ -116259,11 +116668,12 @@ "type": "list" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the Zone ID for the host", "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the cluster ID for the host", @@ -116274,44 +116684,45 @@ "type": "uuid" }, { - "description": "the cluster name for the host", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "clustername", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "hypervisor type of the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "hypervisor", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "the host URL", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "url", - "required": true, + "name": "username", + "required": false, "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": "ip address intentionally allocated to this host after provisioning", + "description": "the Pod ID for the host", "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "name": "podid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "username", + "name": "allocationstate", "required": false, "type": "string" } @@ -116319,19 +116730,20 @@ "related": "", "response": [ { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "the host out-of-band management information", @@ -116339,118 +116751,113 @@ "type": "outofbandmanagementresponse" }, { - "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": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "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 last time this host was annotated", - "name": "lastannotated", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { @@ -116459,51 +116866,56 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "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 state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, { "description": "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": "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 vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -116512,8 +116924,8 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -116522,54 +116934,49 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the 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 name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "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" }, { @@ -116578,44 +116985,44 @@ "type": "long" }, { - "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 cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 ID of the host", - "name": "id", - "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 used", - "name": "memoryused", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the 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 after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the host version", @@ -116623,29 +117030,39 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, { "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "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", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the current status of the latest async job acting on this object", @@ -116653,15 +117070,9 @@ "type": "integer" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - {}, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the ID of the host", + "name": "id", + "type": "string" }, {}, { @@ -116670,13 +117081,13 @@ "type": "integer" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" } ] @@ -116696,41 +117107,51 @@ ], "related": "", "response": [ + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, { "description": "The username of the user that entered the annotation", "name": "username", "type": "string" }, - {}, { - "description": "The (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" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, + {}, { "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -116739,24 +117160,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.11" @@ -116767,17 +117178,17 @@ "name": "deleteProjectRolePermission", "params": [ { - "description": "ID of the project role permission to be deleted", + "description": "ID of the project where the project role permission is to be deleted", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": true, "type": "uuid" }, { - "description": "ID of the project where the project role permission is to be deleted", + "description": "ID of the project role permission to be deleted", "length": 255, - "name": "projectid", + "name": "id", "related": "", "required": true, "type": "uuid" @@ -116785,12 +117196,11 @@ ], "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", @@ -116802,10 +117212,11 @@ "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -116829,22 +117240,22 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ], "since": "4.9.0" @@ -116863,16 +117274,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": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -116884,7 +117285,17 @@ "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" + } ] }, { @@ -116892,6 +117303,14 @@ "isasync": true, "name": "updateVPCOffering", "params": [ + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + }, { "description": "sort key of the VPC offering, integer", "length": 255, @@ -116900,26 +117319,17 @@ "type": "integer" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the display text of the VPC offering", "length": 255, - "name": "state", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "since": "4.13", "type": "string" }, { @@ -116930,16 +117340,17 @@ "type": "string" }, { - "description": "the display text of the VPC offering", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "displaytext", + "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", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", "required": false, "type": "string" } @@ -116947,45 +117358,16 @@ "related": "", "response": [ { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the vpc offering", - "name": "name", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + {}, { "description": "the list of supported services", "name": "service", @@ -116995,14 +117377,36 @@ "name": "name", "type": "string" }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "the provider name", @@ -117019,41 +117423,19 @@ "name": "servicelist", "type": "list" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" } ], @@ -117063,25 +117445,28 @@ "type": "list" }, { - "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", "name": "distributedvpcrouter", "type": "boolean" }, - {}, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the vpc offering", + "name": "name", + "type": "string" }, - {}, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "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" }, { @@ -117090,14 +117475,40 @@ "type": "date" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the 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": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" } ] }, @@ -117115,38 +117526,28 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "", "response": [ {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -117154,35 +117555,29 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "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": "publicip", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -117191,8 +117586,8 @@ "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -117200,6 +117595,22 @@ "name": "state", "type": "string" }, + {}, + { + "description": "the public ip address of the vpn server", + "name": "publicip", + "type": "string" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" + }, { "description": "the range of ips to allocate to the clients", "name": "iprange", @@ -117213,13 +117624,6 @@ "isasync": true, "name": "scaleVirtualMachine", "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 ID of the virtual machine", "length": 255, @@ -117228,14 +117632,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "New minimum number of IOPS for the custom disk offering", "length": 255, @@ -117253,20 +117649,35 @@ "type": "long" }, { - "description": "Verify OK to Shrink", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "shrinkok", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "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": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "automigrate", + "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", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], "response": [ @@ -117275,17 +117686,17 @@ "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", @@ -117300,13 +117711,12 @@ "name": "destroyVirtualMachine", "params": [ { - "description": "Comma separated list of UUIDs for volumes that will be deleted", + "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "expunge", "required": false, - "since": "4.12.0", - "type": "list" + "since": "4.2.1", + "type": "boolean" }, { "description": "The ID of the virtual machine", @@ -117317,92 +117727,21 @@ "type": "uuid" }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, - "name": "expunge", + "name": "volumeids", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.2.1", - "type": "boolean" + "since": "4.12.0", + "type": "list" } ], "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the 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": "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "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.", @@ -117410,69 +117749,33 @@ "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -117480,49 +117783,30 @@ "name": "backupofferingname", "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": "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, + {}, { "description": "the group ID of the virtual machine", "name": "groupid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { @@ -117531,28 +117815,8 @@ "type": "integer" }, { - "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -117560,59 +117824,19 @@ "name": "diskioread", "type": "long" }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, { "description": "the name of the disk offering of the virtual machine", "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -117621,253 +117845,184 @@ "type": "date" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -117876,13 +118031,13 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -117890,42 +118045,82 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "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": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", @@ -117937,13 +118132,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -117952,28 +118147,142 @@ "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", "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 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": "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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, + { + "description": "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", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -117984,299 +118293,411 @@ "name": "icmpcode", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "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 virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, - {}, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - {}, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the 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 list of resource tags associated", - "name": "tags", + "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": "tag key name", - "name": "key", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "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" } ] }, @@ -118318,52 +118739,42 @@ "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag 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" }, { @@ -118372,51 +118783,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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "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 public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -118424,32 +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": "the traffic type for the firewall rule", - "name": "traffictype", - "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 state of the rule", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "since": "4.4" @@ -118460,10 +118881,18 @@ "name": "listOsCategories", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list os category by name", + "length": 255, + "name": "name", "required": false, + "since": "3.0.1", "type": "string" }, { @@ -118475,40 +118904,22 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list os category by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - { - "description": "the name of the OS category", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, { @@ -118520,6 +118931,16 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the name of the OS category", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -118529,13 +118950,11 @@ "name": "listServiceOfferings", "params": [ { - "description": "id of zone disk offering is associated with", + "description": "name of the service offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -118545,18 +118964,27 @@ "type": "string" }, { - "description": "is this a system vm offering", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "issystem", + "name": "cpuspeed", "required": false, - "type": "boolean" + "since": "4.15", + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "isrecursive", + "name": "systemvmtype", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "the RAM memory that listed offering must support", + "length": 255, + "name": "memory", + "required": false, + "since": "4.15", + "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.", @@ -118574,13 +119002,19 @@ "type": "integer" }, { - "description": "the RAM memory that listed offering must support", + "description": "", "length": 255, - "name": "memory", + "name": "pagesize", "required": false, - "since": "4.15", "type": "integer" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -118597,11 +119031,13 @@ "type": "boolean" }, { - "description": "", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.13", + "type": "uuid" }, { "description": "ID of the service offering", @@ -118612,31 +119048,16 @@ "type": "uuid" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, - { - "description": "the CPU number that listed offerings must support", - "length": 255, - "name": "cpunumber", - "required": false, - "since": "4.15", - "type": "integer" - }, - { - "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": "the CPU speed that listed offerings must support", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "cpuspeed", + "name": "cpunumber", "required": false, "since": "4.15", "type": "integer" @@ -118645,13 +119066,13 @@ "related": "updateServiceOffering", "response": [ { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { @@ -118660,9 +119081,19 @@ "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 service offering in case of VMware", + "name": "vspherestoragepolicy", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "is true if the offering is customized", @@ -118670,24 +119101,25 @@ "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, + {}, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { "description": "the host tag for the service offering", @@ -118695,55 +119127,65 @@ "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "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": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "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", + "name": "offerha", + "type": "boolean" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, { "description": "data transfer rate in megabits per second allowed.", "name": "networkrate", "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { "description": "is this a default system vm offering", "name": "defaultuse", "type": "boolean" }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, {}, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { "description": "an alternate display text of the service offering.", @@ -118751,159 +119193,138 @@ "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "true if the 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 display text of the disk offering", - "name": "diskofferingdisplaytext", - "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": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the id of the service 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": "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": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "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": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "the min iops of the disk offering", + "name": "miniops", "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" } ] @@ -118914,20 +119335,20 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "The ID of the load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", + "name": "loadbalancerrulelist", "related": "", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "the list load balancer rules that will be assigned to gloabal load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" } ], "response": [ @@ -118936,12 +119357,12 @@ "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", @@ -118961,18 +119382,18 @@ "name": "listAffinityGroupTypes", "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": "", @@ -118985,22 +119406,22 @@ "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" + } ] }, { @@ -119009,27 +119430,19 @@ "name": "listCapacity", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "recalculate capacities and fetch the latest", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "fetchlatest", + "name": "sortby", "required": false, "since": "3.0.0", - "type": "boolean" + "type": "string" }, { - "description": "Sort the results. Available values: Usage", + "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": "sortby", + "name": "type", "required": false, - "since": "3.0.0", - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -119039,13 +119452,11 @@ "type": "string" }, { - "description": "lists capacity by the Cluster ID", + "description": "", "length": 255, - "name": "clusterid", - "related": "", + "name": "page", "required": false, - "since": "3.0.0", - "type": "uuid" + "type": "integer" }, { "description": "", @@ -119055,45 +119466,59 @@ "type": "integer" }, { - "description": "lists capacity by the Pod ID", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "podid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "lists capacity by the Zone ID", + "description": "lists capacity by the Cluster ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clusterid", + "related": "", "required": false, + "since": "3.0.0", "type": "uuid" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "type", + "name": "fetchlatest", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "boolean" + }, + { + "description": "lists capacity by the Pod ID", + "length": 255, + "name": "podid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the capacity type", + "name": "type", + "type": "short" }, - {}, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -119101,19 +119526,20 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -119122,8 +119548,8 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -119132,24 +119558,19 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -119159,15 +119580,6 @@ "isasync": true, "name": "startVirtualMachine", "params": [ - { - "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, @@ -119176,14 +119588,6 @@ "since": "4.4", "type": "string" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - }, { "description": "Boot into hardware setup menu or not", "length": 255, @@ -119192,6 +119596,22 @@ "since": "4.15.0.0", "type": "boolean" }, + { + "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 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 Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, @@ -119201,334 +119621,443 @@ "type": "uuid" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", + "name": "hostid", "related": "", "required": false, + "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the 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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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 project id of the vm", - "name": "projectid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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" + }, + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -119537,13 +120066,13 @@ "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -119552,109 +120081,64 @@ "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -119663,503 +120147,450 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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 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": "ssh key-pairs", - "name": "keypairs", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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 description of the security group", - "name": "description", + "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": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "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": "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": "the project name of the group", - "name": "project", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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": "the domain ID of the security group", - "name": "domainid", + "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 project id of the group", - "name": "projectid", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "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", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -120170,19 +120601,11 @@ "name": "updateServiceOffering", "params": [ { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "the display text of the service offering to be updated", + "description": "sort key of the service offering, integer", "length": 255, - "name": "displaytext", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { "description": "the name of the service offering to be updated", @@ -120192,18 +120615,19 @@ "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "length": 255, + "name": "storagetags", "required": false, + "since": "4.16", "type": "string" }, { - "description": "sort key of the service offering, integer", + "description": "the display text of the service offering to be updated", "length": 255, - "name": "sortkey", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the service offering to be updated", @@ -120213,6 +120637,14 @@ "required": true, "type": "uuid" }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, { "description": "the host tag for this service offering.", "length": 255, @@ -120222,81 +120654,65 @@ "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "since": "4.16", "type": "string" } ], "related": "", "response": [ { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "the memory in MB", - "name": "memory", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the ha support in the service offering", + "name": "offerha", "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": "the id of the service offering", - "name": "id", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, + {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - {}, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "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": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", @@ -120304,18 +120720,23 @@ "type": "integer" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "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 ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + { + "description": "the id of the service offering", + "name": "id", "type": "string" }, { @@ -120324,45 +120745,64 @@ "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "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", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, - {}, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { "description": "additional key/value details tied with this service offering", @@ -120370,48 +120810,48 @@ "type": "map" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { @@ -120420,44 +120860,40 @@ "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "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 name of the service offering", + "name": "name", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "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": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, + {}, { - "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": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -120465,34 +120901,29 @@ "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, - { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" } ] }, @@ -120519,64 +120950,74 @@ ], "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "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 name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "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 ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "tag key name", + "name": "key", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -120588,251 +121029,511 @@ "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "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 traffic type of the nic", - "name": "traffictype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the 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": "OS name of the vm", - "name": "osdisplayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -120840,80 +121541,97 @@ "name": "name", "type": "string" }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "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": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "Os type ID of the virtual machine", @@ -120921,33 +121639,18 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -120956,38 +121659,13 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "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", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -120996,479 +121674,242 @@ "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - {}, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "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": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "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 service offering of the virtual machine", - "name": "serviceofferingid", + "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security 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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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" } ] }, @@ -121478,19 +121919,19 @@ "name": "createNetworkACLList", "params": [ { - "description": "Name of the network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "ID of the VPC associated with this network ACL list", + "description": "Name of the network ACL list", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Description of the network ACL list", @@ -121500,27 +121941,27 @@ "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "ID of the VPC associated with this network ACL list", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "Description of the ACL", - "name": "description", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, + {}, { "description": "Name of the VPC this ACL is associated with", "name": "vpcname", @@ -121531,26 +121972,26 @@ "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 ACL", - "name": "id", - "type": "string" + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Description of the ACL", + "name": "description", + "type": "string" } ] } diff --git a/test/SSHService_test.go b/test/SSHService_test.go index 5995106b..d3ade54a 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()) From 682614f1f482b35b750e9e518c8c85addf6c94a4 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 17 Mar 2023 18:37:48 +0530 Subject: [PATCH 3/3] add 4.17 new apis Signed-off-by: Abhishek Kumar --- cloudstack/AddressService.go | 90 ++ cloudstack/AddressService_mock.go | 29 + cloudstack/ConfigurationService.go | 176 ++++ cloudstack/ConfigurationService_mock.go | 29 + cloudstack/FirewallService.go | 973 ++++++++++++++++++ cloudstack/FirewallService_mock.go | 137 +++ cloudstack/InfrastructureUsageService.go | 366 +++++++ cloudstack/InfrastructureUsageService_mock.go | 174 ++++ cloudstack/NetworkService.go | 822 +++++++++++++++ cloudstack/NetworkService_mock.go | 224 ++++ 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/VLANService.go | 210 ++++ cloudstack/VLANService_mock.go | 29 + cloudstack/VirtualMachineService.go | 284 +++++ cloudstack/VirtualMachineService_mock.go | 92 ++ cloudstack/VolumeService.go | 260 +++++ cloudstack/VolumeService_mock.go | 29 + cloudstack/cloudstack.go | 11 + generate/layout.go | 24 + test/AddressService_test.go | 12 + test/ConfigurationService_test.go | 12 + test/FirewallService_test.go | 54 + test/InfrastructureUsageService_test.go | 62 ++ test/NetworkService_test.go | 87 ++ test/SystemVMService_test.go | 12 + test/TemplateService_test.go | 24 + test/UsageService_test.go | 12 + test/VLANService_test.go | 12 + test/VirtualMachineService_test.go | 12 + test/VolumeService_test.go | 15 + test/testdata/KubernetesService.json | 48 +- 36 files changed, 4887 insertions(+), 6 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/AddressService.go b/cloudstack/AddressService.go index dacecc26..9fcbd9e3 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 e9032ae2..fb587a8e 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/ConfigurationService.go b/cloudstack/ConfigurationService.go index ee60f392..80394440 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -34,6 +34,8 @@ type ConfigurationServiceIface interface { NewListDeploymentPlannersParams() *ListDeploymentPlannersParams UpdateConfiguration(p *UpdateConfigurationParams) (*UpdateConfigurationResponse, error) NewUpdateConfigurationParams(name string) *UpdateConfigurationParams + ResetConfiguration(p *ResetConfigurationParams) (*ResetConfigurationResponse, error) + NewResetConfigurationParams(name string) *ResetConfigurationParams } type ListCapabilitiesParams struct { @@ -649,3 +651,177 @@ type UpdateConfigurationResponse struct { Scope string `json:"scope"` Value string `json:"value"` } + +type ResetConfigurationParams struct { + p map[string]interface{} +} + +func (p *ResetConfigurationParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["accountid"]; found { + u.Set("accountid", v.(string)) + } + if v, found := p.p["clusterid"]; found { + u.Set("clusterid", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["imagestoreid"]; found { + u.Set("imagestoreid", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ResetConfigurationParams) SetAccountid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountid"] = v +} + +func (p *ResetConfigurationParams) GetAccountid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountid"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetClusterid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["clusterid"] = v +} + +func (p *ResetConfigurationParams) GetClusterid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["clusterid"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ResetConfigurationParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetImagestoreid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["imagestoreid"] = v +} + +func (p *ResetConfigurationParams) GetImagestoreid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["imagestoreid"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ResetConfigurationParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ResetConfigurationParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + +func (p *ResetConfigurationParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ResetConfigurationParams) 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 ResetConfigurationParams instance, +// as then you are sure you have configured all required params +func (s *ConfigurationService) NewResetConfigurationParams(name string) *ResetConfigurationParams { + p := &ResetConfigurationParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + return p +} + +// Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings +func (s *ConfigurationService) ResetConfiguration(p *ResetConfigurationParams) (*ResetConfigurationResponse, error) { + resp, err := s.cs.newRequest("resetConfiguration", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ResetConfigurationResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ResetConfigurationResponse struct { + Category string `json:"category"` + Description string `json:"description"` + Id int64 `json:"id"` + Isdynamic bool `json:"isdynamic"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Scope string `json:"scope"` + Value string `json:"value"` +} diff --git a/cloudstack/ConfigurationService_mock.go b/cloudstack/ConfigurationService_mock.go index 7c593059..ac31e8ee 100644 --- a/cloudstack/ConfigurationService_mock.go +++ b/cloudstack/ConfigurationService_mock.go @@ -139,6 +139,20 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) NewListDeploymentPlannersPa return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListDeploymentPlannersParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewListDeploymentPlannersParams)) } +// NewResetConfigurationParams mocks base method. +func (m *MockConfigurationServiceIface) NewResetConfigurationParams(name string) *ResetConfigurationParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewResetConfigurationParams", name) + ret0, _ := ret[0].(*ResetConfigurationParams) + return ret0 +} + +// NewResetConfigurationParams indicates an expected call of NewResetConfigurationParams. +func (mr *MockConfigurationServiceIfaceMockRecorder) NewResetConfigurationParams(name interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewResetConfigurationParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewResetConfigurationParams), name) +} + // NewUpdateConfigurationParams mocks base method. func (m *MockConfigurationServiceIface) NewUpdateConfigurationParams(name string) *UpdateConfigurationParams { m.ctrl.T.Helper() @@ -153,6 +167,21 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) NewUpdateConfigurationParam return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateConfigurationParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewUpdateConfigurationParams), name) } +// ResetConfiguration mocks base method. +func (m *MockConfigurationServiceIface) ResetConfiguration(p *ResetConfigurationParams) (*ResetConfigurationResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ResetConfiguration", p) + ret0, _ := ret[0].(*ResetConfigurationResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ResetConfiguration indicates an expected call of ResetConfiguration. +func (mr *MockConfigurationServiceIfaceMockRecorder) ResetConfiguration(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ResetConfiguration", reflect.TypeOf((*MockConfigurationServiceIface)(nil).ResetConfiguration), p) +} + // UpdateConfiguration mocks base method. func (m *MockConfigurationServiceIface) UpdateConfiguration(p *UpdateConfigurationParams) (*UpdateConfigurationResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/FirewallService.go b/cloudstack/FirewallService.go index 3e034465..353cee9e 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 { @@ -3229,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 32e19bbd..471a6839 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/InfrastructureUsageService.go b/cloudstack/InfrastructureUsageService.go new file mode 100644 index 00000000..d8a29803 --- /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 00000000..cca28997 --- /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/NetworkService.go b/cloudstack/NetworkService.go index fbcf408d..125c619c 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 { @@ -5778,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 1e5efd35..82f872ec 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/SystemVMService.go b/cloudstack/SystemVMService.go index 9f648b2e..36e418eb 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 9c03657b..d29fbcbc 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 64238812..510a2497 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 1cbf7c64..01cadf73 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 3e2315c4..76625657 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 bcd55e42..9ff4854d 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/VLANService.go b/cloudstack/VLANService.go index 79a1be21..b85bb623 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 { @@ -1350,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 04ca582a..9d9697ed 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/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 0d16f97f..e7821072 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 { @@ -7658,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 3de35374..bc1c8ae6 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 d2348ae6..727a4c19 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 { @@ -3928,3 +3930,261 @@ type UploadVolumeResponse struct { 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"` + 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"` +} diff --git a/cloudstack/VolumeService_mock.go b/cloudstack/VolumeService_mock.go index 3e12e0d0..1984c0ae 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 79633b19..7c0d18b8 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) @@ -940,6 +943,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 a7ec89dd..c206452f 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", @@ -596,6 +614,7 @@ var layout = apiInfo{ "listConfigurations", "listDeploymentPlanners", "updateConfiguration", + "resetConfiguration", }, "BrocadeVCSService": { "addBrocadeVcsDevice", @@ -614,6 +633,7 @@ var layout = apiInfo{ "disassociateIpAddress", "listPublicIpAddresses", "updateIpAddress", + "releaseIpAddress", }, "StoragePoolService": { "cancelStorageMaintenance", @@ -698,4 +718,8 @@ var layout = apiInfo{ "updateKubernetesSupportedVersion", "upgradeKubernetesCluster", }, + "InfrastructureUsageService": { + "listManagementServersMetrics", + "listDbMetrics", + }, } diff --git a/test/AddressService_test.go b/test/AddressService_test.go index 39a05c82..9d534cd1 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/ConfigurationService_test.go b/test/ConfigurationService_test.go index 355fb730..456d8ddc 100644 --- a/test/ConfigurationService_test.go +++ b/test/ConfigurationService_test.go @@ -83,4 +83,16 @@ func TestConfigurationService(t *testing.T) { } t.Run("UpdateConfiguration", testupdateConfiguration) + testresetConfiguration := func(t *testing.T) { + if _, ok := response["resetConfiguration"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Configuration.NewResetConfigurationParams("name") + _, err := client.Configuration.ResetConfiguration(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ResetConfiguration", testresetConfiguration) + } diff --git a/test/FirewallService_test.go b/test/FirewallService_test.go index daef8454..6e00e0c7 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 00000000..a852f829 --- /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 930cea80..4e408c04 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/SystemVMService_test.go b/test/SystemVMService_test.go index 480789b6..e958d729 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 cacd61f0..a41df240 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 992ce028..bd7a1e3a 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 e7b1bfe5..bbc1c764 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/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 4a8785f8..3fb706cf 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 1869db29..1ff7efd0 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 003b7ea1..df7600c2 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",